Меасофт - Вклад участника [ru]

Руководство программиста

2025-01-27T17:30:21Z

Johny:

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

1. При использовании значения как параметр функции интерпретатор автоматически приводит значение к типу, необходимому функции.

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

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

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.

Abs(f) - возвращает модуль числа f.

''Подсказка: для простого округления используется функция int()''

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit - Устанавливает автоматическую высоту строк.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «MEASOFT». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber) - Выполняет указанную печатную форму в объекте excel. Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Применение языка формул ==
'''в различных контекстах системы «MEASOFT» и сопутствующих проектах'''

=== MEASOFT ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Руководство программиста

2025-01-27T17:28:59Z

Johny: /* Основные положения */

== Основные положения ==

В систему «MEASOFT» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

1. При использовании значения как параметр функции интерпретатор автоматически приводит значение к типу, необходимому функции.

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr [,start]) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Параметр start - это позиция старта поиска, не обязательный параметр, по умолчанию равен 1. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

SetParam(s, p, i) – заменяет на значение p i-й элемент строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

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

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

FirstDayOfMonth(dt) – Возвращает первый день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( FirstDayOfMonth( CurrDate() ) );

LastDayOfMonth(dt) – Возвращает последний день месяца в формате DD.MM.YYYY для даты dt в формате DD.MM.YYYY. Пример вызова: Error( LastDayOfMonth( CurrDate() ) );

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0], [DefaultHolidayVarNum=1]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней(по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1],[DefaultHolidayVarNum=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным. Параметр DefaultHolidayVarNum - использовать для расчета справочник: 1 - выходных дней (по умолчанию); 2 - выходных дней для доставки по городу; 3 - выходных дней для доставки

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.

Abs(f) - возвращает модуль числа f.

''Подсказка: для простого округления используется функция int()''

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding [, append])- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Если append = true, то производится дописывание данных в файл, а не перезаписывание (не обязательный, по умолчанию выключен).

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - Дополнительные заголовки HTTP запроса, передается в виде списка параметров через запятую и всегда образуют пару: 1 параметр - название заголовка, 2 параметр - значение. Если значение содержит запятую то его нужно экранировать в двойные кавычки. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в миллисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

LastHttpError - Выводит последний запрос выполненный с ошибкой в функции HttpPost. Содержит подробную информацию по запросу и ответу.

LastHttpResponse - Выводит последний запрос и ответ от сервера после выполнения Http-запроса в функции HttpPost.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Если TranslateHeader истинно, то заголовки таблицы будут автоматически переведены.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1][, TranslateHeader=False]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit - Устанавливает автоматическую высоту строк.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{| class="wikitable"
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|-
|GetSQL
|Для отладки. Возвращает последний SQL запрос переданный в методы Open, Query, GetSQLValue
|-
|ExportExcel
|Для отладки. Выгружает в эксель содержимое датасета. Можно использовать в незнакомом окружении для понимания передаваемых полей в : шаблонах, печатных формах и т.д. Аналог команды %echo% в шаблонах, на случай если она не сработает.
|-
|OnGetText
|Функция подменяет текстовый вывод значения поля при выгрузке в эксель. Первый параметр это имя поля, которое надо подменить. Второй параметр это то что необходимо вывести. Работает только с текстовыми полями.
'''''Пример использования'''''
DB.OnGetText('Зона', IF((DB.FieldByName('-Lat') ! 0) * (DB.FieldByName('-Lon') ! 0),
GetPolygonByLatLon(DB.FieldByName('-Lat'), DB.FieldByName('-Lon'), 'TYPE = 1 AND IFNULL(zone, 0) > 0 AND PRICE = ' + DB.FieldByName('-price'), 'zone')
,
''
));
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

GetDefaultPrinter - Возвращает имя текущего активного принтера.

SetDefaultPrinter(Printer) – Запоминает предыдущий активный принтер и устанавливает новый текущий принтер. Printer - имя принтера. При необходимости нескольких последовательных вызовов SetDefaultPrinter рекомендуется между вызовами использовать RestoreDefaultPrinter.

RestoreDefaultPrinter - Устанавливает активным принтер, который был текущим перед последним вызовом SetDefaultPrinter.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Для кода DataMatrix можно установить режим для печати скрытых символов с кодами 29(GS) и 232(FCN1), которые требуются для формирования Честного Знака. Для этого необходимо в начале строки указать символ "[" и все разделители 01, 21, 91, 92 так же экранировать этими скобками. Должно получиться [01]02900002317701[21]k3LInNbH_oG0Q[91]EE06[92]YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= . При формировании кода, включится режим формирования штрих-кода DataMatrix GS1, в начале будет добавлен символ с кодом 232 (FCN1), а потом будут добавлены разделители с кодом 29 (GS)
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «Курьерская служба 2008». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator][,Correction])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1.
Поле Correction позволяет указать данные для корректировочного чека, используется в системе Штрих-М. По умолчанию пустая строка. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Работа функции может быть изменена системной доп. возможностью OnCreateAddressForActDelivery.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''GetRouteCode(AddressText, TownCode, LatLon[, Lon])''' - для адреса AddressText в городе с кодом TownCode (из таблицы Town) по географическим координатам lat, lon возвращает код роута (записи, хранящей координаты адреса в городе). Если роут не найден (для адреса в городе не найдено записи с указанными координатами) - создает новый роут и возвращает его код, если роут найден (был создан ранее) - обновляет у роута координаты. Если параметр Lon задан, то параметр LatLon должен содержать одну координату, иначе LatLon должен содержать строку вида 'lat, lon'.
В случае ошибки возвращает Null.

Пример:<br>
Set($res, GetRouteCode(address, townto, '55.114034, 36.592397'));<br>
Set($res, GetRouteCode('Троицк, Полковника милиции Курочкина ул., 11', 1, '37.467446, 55.740537'));<br>
Set($res, GetRouteCode('Обнинск, Маркса пр., 20', TownByName('Обнинск'), 55.114034, 36.592397));

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''CalcClientCnt(client_code, date, is_intown [, date_put=CurrDate(), skipajust=false])''' - функция расчета количество доставленных корреспонденций у клиента с кодом client_code за предыдущий месяц от даты date (Или за текущий месяц, подробнее смотри переменную UseCurrentMonthCount) среди внутригородских (is_intown = true) либо междугородних (is_intown = false) корреспонденций, date_put - дата доставки (для альтернативного способа подсчета, включаемого переменной UseDatePutForCalcCnt), skipajust - не учитывать принудительно введенные количества (таблица priceclientadjust типы записей 0 и 1).

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber) - Выполняет указанную печатную форму в объекте excel. Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

'''VoiceReadStr(str)''' – Озвучивает фразу str голосовым уведомлением доступными словами из базы. Может содержать тег "{break_off}" для того, чтобы сделать эту фразу не пропускаемой в очереди воспроизведения.

'''CalcStorageCost(ClientCodes, DateFrom, DateTo, NeedReport[, Store])''' – рассчитывает стоимость хранения на складе для выбранных клиентов (ClientCodes - коды клиентов через запятую), в период дат с DateFrom до DateTo, с прикреплением к корреспонденции отчета в зависимости от выставленного параметра NeedReport. Может содержать параметр Store - код филиала, по умолчанию пустой (расчет выполняется для всех филиалов). Возвращает коды созданных корреспонденций через запятую.

'''WriteOut(DocId, ItemId, Date, Cnt[, BC])''' – производит списание товара со склада. DocId - код (docs.code) документа списания, ItemId - код товара (item.code), Date - дата операции, Cnt - количество списываемого товара, BC- штрих-код товара, для товара с учетом серийных номеров нужно обязательно указывать серийный номер. Если указан BC, то параметр ItemId игнорируется и поиск номенклатуры происходит исключительно по штрих-коду. В случае успеха, функция возвращает строку вида: код номенклатуры, списанное кол-во

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

'''Функции общего назначения''':

'''ExecSimpleScript(Caption, Text)''' - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

'''FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns,ShowAll])''' - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. ShowAll - показать все дополнительные услуги, по умолчанию false и показывает только услуги с начислениями. Функция возвращает количество использованных столбцов.

'''PrintSticker(Codes, [ToBoxes=False])'''

'''GetItemByName(Name)'''

'''GetA4Printer''' - возвращает имя принтера выбранного для печати документов

'''GetStickerPrinter''' - возвращает имя принтера выбранного для печати стикеров

'''GetDuplexPrinter''' - возвращает имя принтера выбранного для двусторонней печати, если принтер не выбран, возвращает пустую строку

'''PrintAttachPDFPage(Code, FileName, Page, Printer)''' - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

'''AttachPDFToText(Code, [TextFileName])''' - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''GetActiveForm([SkipFormName])''' - возвращает код активной формы в программе где происходит сканирование. SkipFormName - не обязательны параметр, имя формы которую нужно пропустить при определении интерфейса.
'''Список интерфейсов''':
0 - неопределенный;
1 - прием корреспонденции на склад;
2 - АПД;
3 - комплектация адресов (ShelfingForm);
4 - доска приема;
9 - вкладка «Манифесты»;
10 - Инвентаризация корреспонденции;
11 - АПК;
12 - вкладка «Адреса»;
13 - вкладка «Выдача»;
14 - вкладка «Склад»;
15 - Список номенклатуры;
16 - Инвентаризация склада;
17 - Приходная накладная;
18 - Списание товара;
19 - Карточка корреспонденции.

'''AddAddressScanLog(Code[, StrBarCode, IsManual, FromInterface, ExtraInfo])''' - добавляет событие сканирование для корреспонденции с кодом Code. Необязательные параметры: StrBarCode - сканируемый ШК корреспонденции (по умолчанию пустой), IsManual - галка ручного сканирования (по умолчанию false), FromInterface - код интерфейса сканирования (StateType=81, по умолчанию 0 - неопределенный), ExtraInfo - текстовый комментарий события.

'''RuleName(alias)''' - Выдает полный путь в дерева прав по псевдониму права.

'''ShowScanError(msg [, Speek])''' - выдает пользователю окно с текстом msg блокируя последующие действия сканирования. Если Speek - истинно, то сообщение проговаривается голосовым движком, по умолчанию выключено.

'''CheckRule(alias)''' - функция проверки разрешения у текущего пользователя системы, alias - псевдоним права. Возвращает 1, если право есть и 0, если права нет.
Пример: if(CheckRule('RSE'), ShowMessage('У пользователя есть право изменять счета'), ShowMessage('У пользователя нет права изменять счета'));

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

ClientTown - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Создается только автоматически. Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Объект TMessage ==
Создается только автоматически. Объект используется для скриптовой обработки письма в [https://wiki.courierexe.ru/index.php/%D0%9D%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0_%D0%BC%D0%BE%D0%B4%D1%83%D0%BB%D1%8F_%D0%B0%D0%B2%D1%82%D0%BE%D0%BC%D0%B0%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D0%B8#.D0.98.D0.BC.D0.BF.D0.BE.D1.80.D1.82_.D0.B4.D0.B0.D0.BD.D0.BD.D1.8B.D1.85| заданиях импорта данных]. В себе содержит текст письма в очищенном формате и оригинальном формате HTML, отправитель письма, тему письма, дата получения и список прикрепленных файлов.

'''Message.Text''' - возвращает очищенный от HTML-тегов текст письма.

'''Message.HTMLText''' - возвращает оригинальный текст письма со всеми HTML-тегами.

'''Message.Sender''' - возвращает email-адрес отправителя письма.

'''Message.AttachmentsCount''' - возвращает количество вложенных файлов.

'''Message.DateTime''' - возвращает дату и время получения письма.

'''Message.Subject''' - возвращает тему письма.

'''Message.GetAttachmentDataString(Number)''' - возвращает вложенный файл под номером Number в виде строки.

'''Message.GetAttachmentName(Number)''' - возвращает имя вложенного файла под номером Number.

== Применение языка формул ==
'''в различных контекстах системы «Курьерская служба 2008» и сопутствующих проектах'''

=== Курьерская служба 2008 ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с уровнем (pricelevel) меньше текущего.

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Справки о налоговом резидентстве

2023-08-11T11:21:11Z

Johny:

==2024==
Справку о налоговом резидентстве ИП может получить только по прошествии 183-х дней с начала года, т.е в начале Июля. Это факт, мы даже получали соответсвующий комментарий от налоговой. Следите за обновлениями летом!

==2023==
[https://courierexe.ru/download/resident/2023/REPLY_1685169.PDF Казахстан]

[https://courierexe.ru/download/resident/2023/REPLY_1685171.PDF Беларусь]

[https://courierexe.ru/download/resident/2023/REPLY_1685170.PDF Узбекистан]

==2022==

[https://courierexe.ru/download/resident/2022/REPLY_1408920.PDF Казахстан]

[https://courierexe.ru/download/resident/2022/REPLY_1408918.PDF Беларусь]

[https://courierexe.ru/download/resident/2022/REPLY_1408921.PDF Латвия]

[https://courierexe.ru/download/resident/2022/REPLY_1408923.PDF Киргизия]

[https://courierexe.ru/download/resident/2022/REPLY_1408919.PDF Узбекистан]

[https://courierexe.ru/download/resident/2022/REPLY_1408922.PDF Таджикистан]

==2021==

[https://courierexe.ru/download/resident/2021/REPLY_1063591.PDF Казахстан]

[https://courierexe.ru/download/resident/2021/REPLY_1063595.PDF Беларусь]

[https://courierexe.ru/download/resident/2021/REPLY_1063593.PDF Латвия]

[https://courierexe.ru/download/resident/2021/REPLY_1063596.PDF Киргизия]

[https://courierexe.ru/download/resident/2021/REPLY_1063592.PDF Узбекистан]

[https://courierexe.ru/download/resident/2021/REPLY_1063594.PDF Таджикистан]

==2020==

[https://courierexe.ru/download/resident/2020/REPLY_746895.PDF Казахстан]

[https://courierexe.ru/download/resident/2020/REPLY_746896.PDF Беларусь]

[https://courierexe.ru/download/resident/2020/REPLY_746897.PDF Латвия]

[https://courierexe.ru/download/resident/2020/REPLY_746898.PDF Киргизия]

[https://courierexe.ru/download/resident/2020/REPLY_746899.PDF Узбекистан]

[https://courierexe.ru/download/resident/2020/REPLY_746900.PDF Таджикистан]

== 2019 ==

[https://courierexe.ru/download/resident/2019/REPLY_593211.PDF Казахстан]

[https://courierexe.ru/download/resident/2019/REPLY_604513.PDF Беларусь]

[https://courierexe.ru/download/resident/2019/REPLY_605887.PDF Латвия]

[https://courierexe.ru/download/resident/2019/REPLY_605888.PDF Киргизия]

[https://courierexe.ru/download/resident/2019/REPLY_605889.PDF Узбекистан]

== 2018 ==

[https://courierexe.ru/download/resident/2018/REPLY_285888.PDF Казахстан]

Webhook

2023-06-14T12:39:26Z

Johny:

'''Webhook передает данные по заказам и статусам на ваш URL.'''

Чтобы создать оповещение о статусах на ваш URL, в разделе [[Личный_кабинет_клиента#Интеграция|"Интеграции"]] создайте интеграцию с типом "Webhook". В настройках укажите URL на который мы будем отправлять уведомление.

Пример запроса:
<source lang=xml>
<?xml version="1.0"?>
<order orderno="00032011" awb="00032011" orderno2="" ordercode="0000032" givencode="">
<barcode>00032011</barcode>
<sender>
<company>TEST</company>
<date/>
<time_min/>
<time_max/>
</sender>
<receiver>
<company>TEST2</company>
<person/>
<phone>+7 (495) 000-00-00</phone>
<contacts>
<phone>+74950000000</phone>
</contacts>
<inn/>
<zipcode/>
<date>2022-01-21</date>
<time_min/>
<time_max/>
<coords lat="55.7287" lon="37.6447"/>
<deliveryPIN/>
</receiver>
<pickup>NO</pickup>
<return>YES</return>
<weight>0.4</weight>
<return_weight/>
<quantity>1</quantity>
<paytype>NO</paytype>
<print_check>YES</print_check>
<service>1</service>
<return_service>1</return_service>
<type>1</type>
<return_type>1</return_type>
<waittime>0</waittime>
<price>0.00</price>
<inshprice>0.00</inshprice>
<enclosure/>
<instruction/>
<basestatus code="0"/>
<currcoords lat="" lon="" accuracy="" RequestDateTime=""/>
<receiverpays>NO</receiverpays>
<acceptpartially>YES</acceptpartially>
<status eventstore="NEW" eventtime="2022-01-20 17:08:43" createtimegmt="2022-01-20 17:08:43" message="" title="new">NEW</status>
<statushistory>
<status eventstore="NEW" eventtime="2022-01-20 17:08:43" createtimegmt="2022-01-20 17:08:43" message="" title="NEW" country="RU">NEW</status>
</statushistory>
<customstatecode>1</customstatecode>
<clientstatecode/>
<department/>
<return_message/>
<deliveredto/>
<delivereddate/>
<deliveredtime/>
<outstrbarcode/>
<arrival/>
<costcode/>
<receipt/>
<items>
</items>
<packages>
</packages>
<webhook_status_code>NEW</webhook_status_code>
</order>
</source>

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
В случае успешной обработки вебхука, наша система ожидает от вас ответ
</div>

<source lang=json>
{
"success": true
}
</source>

Webhook

2023-06-14T12:25:34Z

Johny:

'''Webhook передает данные по заказам и статусам на ваш URL.'''

Чтобы создать оповещение о статусах на ваш URL, в разделе интеграции создайте интеграцию с типом "Webhook". В настройках укажите URL на который мы будем отправлять уведомление.

Пример запроса:
<source lang=xml>
<?xml version="1.0"?>
<order orderno="00032011" awb="00032011" orderno2="" ordercode="0000032" givencode="">
<barcode>00032011</barcode>
<sender>
<company>TEST</company>
<date/>
<time_min/>
<time_max/>
</sender>
<receiver>
<company>TEST2</company>
<person/>
<phone>+7 (495) 000-00-00</phone>
<contacts>
<phone>+74950000000</phone>
</contacts>
<inn/>
<zipcode/>
<date>2022-01-21</date>
<time_min/>
<time_max/>
<coords lat="55.7287" lon="37.6447"/>
<deliveryPIN/>
</receiver>
<pickup>NO</pickup>
<return>YES</return>
<weight>0.4</weight>
<return_weight/>
<quantity>1</quantity>
<paytype>NO</paytype>
<print_check>YES</print_check>
<service>1</service>
<return_service>1</return_service>
<type>1</type>
<return_type>1</return_type>
<waittime>0</waittime>
<price>0.00</price>
<inshprice>0.00</inshprice>
<enclosure/>
<instruction/>
<basestatus code="0"/>
<currcoords lat="" lon="" accuracy="" RequestDateTime=""/>
<receiverpays>NO</receiverpays>
<acceptpartially>YES</acceptpartially>
<status eventstore="NEW" eventtime="2022-01-20 17:08:43" createtimegmt="2022-01-20 17:08:43" message="" title="new">NEW</status>
<statushistory>
<status eventstore="NEW" eventtime="2022-01-20 17:08:43" createtimegmt="2022-01-20 17:08:43" message="" title="NEW" country="RU">NEW</status>
</statushistory>
<customstatecode>1</customstatecode>
<clientstatecode/>
<department/>
<return_message/>
<deliveredto/>
<delivereddate/>
<deliveredtime/>
<outstrbarcode/>
<arrival/>
<costcode/>
<receipt/>
<items>
</items>
<packages>
</packages>
<webhook_status_code>NEW</webhook_status_code>
</order>
</source>

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
В случае успешной обработки вебхука, наша система ожидает от вас ответ
</div>

<source lang=json>
{
"success": true
}
</source>

RetailCRM

2023-01-09T16:20:40Z

Johny: /* Исключение дублирования печати чеков */

== Настройка интеграции ==

# В RetailСRM cоздайте API-ключ. Для этого откройте '''Настройки''' > '''Интеграция''' > '''Ключи доступа к API''' и нажмите на кнопку '''Добавить'''. Откроется страница «Новый ключ API». На этой странице:
## В поле '''Комментарий''' введите краткое описание интеграции, например «По городу».
## В поле '''Тип доступа''' выберите '''Доступ ко всем магазинам'''.
## В списке '''Разрешенные методы API''' установите все флажки.
## Нажмите на кнопку '''Сохранить'''.
#: API-ключей может быть несколько, и для каждого API-ключа необходимо выполнить эти настройки. Подробнее об управлении API-ключами см. [https://help.retailcrm.ru/Users/ApiKeys документацию RetailCRM].
# Настройте интеграцию в [[Личный кабинет клиента#Интеграция|личном кабинете клиента MeaSoft]]:
## Выберите пункт основного меню '''Настройки''' > '''Интеграция''', перейдите на вкладку '''Настройки интеграции''' и в списке «Все интеграции» в строке «RetailCRM» нажмите '''Добавить'''.
## В окне «Настройка интеграции RetailCRM» укажите название интеграции, домен RetailCRM, созданный выше API-ключ. При необходимости укажите значения других полей. Описание некоторых полей:
##* '''Получать статусы доставки''' — выберите '''Получать''', чтобы в RetailCRM передавались статусы заказа из MeaSoft. Настройки передачи статусов для RetailCRM см. в разделе [[#Передача статусов из MeaSoft|«Передача статусов из MeaSoft»]];
##* '''Получать тип и сумму оплаты''' — выберите значение '''Получать''', чтобы получать тип и сумму оплаты из MeaSoft. Если тип оплаты, указанный в заказе, не совпадает с типом оплаты в MeaSoft и цена заказа не равна нулю, платеж в RetailCRM удаляется, создается новый платеж с суммой и типом оплаты из MeaSoft. Данные передаются, если в заказе осталась только одна сумма к оплате;
##* '''Код поля для имени курьера''' — укажите символьный код пользовательского поля в заказе RetailCRM, в которое будет передано имя курьера. Чтобы создать поле или увидеть символьный код, в RetailCRM выберите '''Настройки''' > '''Системные''' > '''Пользовательские поля'''. Подробнее о настройке пользовательских полей см. [https://help.retailcrm.ru/Users/CustomFields документацию RetailCRM];
##* '''Код статуса оплаты''' — укажите символьный код статуса платежа, чтобы в RetailCRM отображался статус платежа после доставки заказа. Чтобы увидеть символьный код статуса, в RetailCRM выберите '''Настройки''' > '''Справочники''' > '''Статусы оплат'''. Статус платежа передается, если на момент закрытия заказа оставалась только одна сумма к оплате;
##* '''Использовать данные склада как отправителя''' — если выбрано значение '''Использовать''', данные отправителя заполняются следующей информацией о складе: адрес, название склада, телефон контактного лица ('''Настройки''' > '''Магазины''' > '''Склады''');
##* '''Передавать ФИО получателя из пользовательского поля''' — укажите символьный код пользовательского поля в заказе RetailCRM, в которое вводится имя фактического получателя. Чтобы создать поле или увидеть символьный код, в RetailCRM выберите '''Настройки''' > '''Системные''' > '''Пользовательские поля'''. Подробнее о настройке пользовательских полей см. [https://help.retailcrm.ru/Users/CustomFields документацию RetailCRM];
##* '''Передавать телефон получателя из пользовательского поля''' — укажите символьный код пользовательского поля в заказе RetailCRM, в которое вводится телефон фактического получателя. Чтобы создать поле или увидеть символьный код, в RetailCRM выберите '''Настройки''' > '''Системные''' > '''Пользовательские поля'''. Подробнее о настройке пользовательских полей см. [https://help.retailcrm.ru/Users/CustomFields документацию RetailCRM].
##* '''Обновлять заказ при изменении''' — определяет, будет ли заказ в MeaSoft обновлен при изменении данных на стороне RetailCRM. Возможные значения: '''Да''', '''Нет'''.
#: По завершении настройки нажмите '''Сохранить'''.
# Настройте интеграцию в RetailCRM:
## Откройте '''Настройки''' > '''Справочники''' > '''Типы доставок''' и на странице «Типы доставок» нажмите на кнопку '''Добавить'''. Откроется окно «Новая доставка»:[[Файл:Retail1.png|none|1000 px|]]
## В этом окне заполните обязательные поля и в выпадающем списке '''Интегрировать с''' выберите значение '''Курьерская служба 2008'''.
## Нажмите '''Сохранить'''.

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

Чтобы отправлять заказы в курьерскую службу по статусам и отменять при изменении типа доставки, используйте [[RetailCRM#Настройка триггеров|триггеры]].

== Исключение печати чеков ==
В настройках интеграции есть настройка '''Не печатать чеки для способа оплаты'''.

Данная настройка выводит список способов оплаты из retailCRM.

Вы можете выбрать те способы оплаты, при наличии которых в заказе в систему MeaSoft будет передана нулевая цена по товарам и нулевая сумма по заказу. Это полезно для оплаты заказа безналом по счету юр.лицами и для перемещения товаров между своими складами без оплаты.

== Передача наложенного платежа ==

Чтобы настроить корректную передачу наложенного платежа:
# Откройте '''Настройки''' > '''Интеграция''' и выберите модуль MEASOFT.
# На странице «Настройки интеграции с Курьерская служба 2008» перейдите на вкладку '''Доставка''' и на панели справа выберите пункт '''Способы оплаты'''.
# Установите флажки для способов оплаты, которые могут использоваться для передачи наложенного платежа, и нажмите '''Сохранить '''.[[Файл:Retail5.png|none|1000 px]]

== Передача статусов из MeaSoft ==

Чтобы получать статусы заказа из MeaSoft:
# Откройте '''Настройки''' > '''Интеграция''' и выберите модуль MEASOFT.
# На странице «Настройки интеграции с Курьерская служба 2008» перейдите на вкладку '''Доставка''' и на панели справа выберите пункт '''Статусы'''.
# Настройте сопоставление статусов MeaSoft и RetailCRM. Для этого в столбце «Статус в RetailCRM» из выпадающего списка выберите соответствие для каждого статуса службы доставки. ''' [[Файл:Retail передача статусов.png|none|1000 px]]
# Нажмите на кнопку '''Сохранить'''.

Статус из MeaSoft в RetailCRM передается 1 раз в 30 минут. Поэтому некоторые промежуточные статусы для заказа могут быть пропущены, и будет показан последний выставленный на момент синхронизации статус заказа.

== Проверка интеграции ==
Чтобы проверить настройки интеграции:
# Перейдите в форму создания заказа и убедитесь, что в списке '''Тип доставки''' появилось соответствующее значение:[[Файл:Retail2.png|none|1000 px]]
# Нажмите '''Выбрать тариф'''. Тарифы должны передаваться из настроек курьерской службы:[[Файл:Retail3.png|none|800 px]]<br>В случае ошибки обратитесь в курьерскую службу для настройки тарифов. Проверить тарифы можно в ЛК MeaSoft в разделе '''Калькулятор'''.

==Печатные формы ==

Чтобы в RetailCRM формировать печатные формы, аналогичные формам в Личном кабинете MeaSoft, используйте один из следующих способов:
* в сохраненном заказе на панели действий сверху нажмите '''Печать''' и выберите нужную печатную форму «Курьерская служба»;
* в списке заказов отметьте заказы флажками, внизу страницы нажмите '''Действия''' > '''Распечатать документы''' и выберите печатную форму «Курьерская служба».

== Настройка триггеров ==

;Триггер
:Хранимая процедура специального типа, автоматически выполняющаяся при наступлении заданного события.

Пример: каждый месяц 1-го числа списывается абонентская плата за интернет. Триггер «1-ый день месяца» — это событие, при наступлении которого срабатывает процедура «списание абонентской платы».

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

Для RetailCRM предусмотрены следующие триггеры:
* [[Настройка триггеров для RetailCRM#Передача заказа при смене статуса|«Отправка заказа в MeaSoft»]] — при наступлении события «Смена статуса заказа на "Отправлен в MeaSoft"». При установке статуса, означающего, что заказ отправлен в курьерскую службу, срабатывает триггер, и заказ передается в MeaSoft;
* [[Настройка триггеров для RetailCRM#Отмена заказа при смене типа доставки|«Отмена заказа в MeaSoft»]] — при наступлении события «Смена типа доставки у заказа». При изменении типа доставки с доставки MeaSoft на доставку, например, Почтой России, заказ в MeaSoft отменяется, если он туда передан и имеет статус «Новый» или «Ожидает синхронизации»;
* [[Настройка триггеров для RetailCRM#Передача изменений заказа|«Изменения заказа в MeaSoft»]] — при наступлении события «Изменение заказа в RetailCRM». При изменении заказа в RetailCRM новые данные отправляются в MeSoft, если заказ передан и имеет статус «Новый» или «Ожидает синхронизации».

'''Примечание.''' Триггеры отправки и обновления данных заказа не учитывают [[#Передача наложенного платежа|типы оплат для наложенного платежа]]. Поэтому если наложенный платеж для неоплаченного заказа равен нулю (например, при оплате на сайте), триггер все равно передаст сумму к оплате. Для корректной отправки таких заказов не используйте триггеры.

=== Передача заказа при смене статуса ===

Чтобы настроить триггер:
# Cоздайте пользовательский статус заказа, при установке которого заказ будет автоматически передаваться в курьерскую службу. Можно создать любое количество статусов.
## В RetailCRM выберите '''Настройки''' > '''Статусы''' и нажмите на кнопку '''Добавить'''. Откроется окно «Новый статус»: [[Файл:Rcrm trig103.png|600 px|none]]
## Заполните поля формы. В поле '''Символьный код''' используйте только цифры и латинские буквы без пробелов. Запишите созданный символьный код, он понадобится на следующих шагах.
# Выберите '''Настройки''' > '''Справочники''' > '''Типы доставок'''. Запишите символьные коды доставок, которые будут использоваться в триггере. В примере ниже используются коды outcity и incity.[[Файл:rcrm_trig104.png|600px|none]]
# Откройте '''Настройки''' > '''Триггеры''' и нажмите на кнопку '''+ Триггер'''. Откроется окно «Новый триггер».
#:Заполните поля:
#: '''Название'''. Название триггера, например «Отправка заказа в MeaSoft».
#: В разделе '''Событие''' нажмите на кнопку '''+ Событие''', выберите значение '''Изменение заказа''' и нажмите на кнопку '''Добавить'''.
#: В разделе '''Условие''' установите переключатель '''Редактор''' и добавьте следующий скрипт:
#:<source lang="javascript">
order.getStatus().getCode() in ["SentMeaSoft"] and order.getDeliveryType().getCode() in ["outcity","incity"]
</source>
#:где
#* <code>SentMeaSoft</code> — символьный код статуса заказа. Если нужно указать 2 статуса, напишите их через запятую в виде: <code>["SentMeaSoft","SentMeaSoft_2"]</code> вместо <code>["SentMeaSoft"]</code>;
#* <code>outcity</code>, <code>incity</code> — символьные коды типа доставки. Если нужно указать 1 тип доставки, напишите его в виде <code>["incity"]</code> вместо <code>["outcity","incity"]</code>.
# В разделе '''Действие''' нажмите на кнопку '''+ Действие''', выберите '''Выполнить HTTP-запрос'''. Появятся дополнительные поля настроек. Заполните их следующим образом:
#* '''Адрес''' — https://home.courierexe.ru/reintegrations/requests/trigger/retailcrm;
#* '''HTTP метод''' — '''POST''';
#* '''Передавать параметры''' — '''В теле запроса (urlencode)''';
# Нажмите на кнопку '''Добавить параметр''' 3 раза подряд и заполните появившиеся поля следующими данными:
:::{|class="wikitable"
!Параметр
!Значение
|-
|id||<nowiki>{{ order.getNumber() }}</nowiki>
|-
|sum||<nowiki>{{ order.getIntegrationDeliveryData().getDeclaredSum() }}</nowiki>
|-
|key||<nowiki>{{ order.getIntegrationDeliveryData().getExtraData().deliveryApiKey }}</nowiki>
|}
::'''Примечание'''. Переносы строк не допускаются.
:6. В панели '''Действия''' нажмите '''Сохранить''', затем сохраните триггер.

:[[Файл:Новый триггер.png|600 px|none]]

Триггер настроен.

=== Отмена заказа при смене статуса ===

Чтобы настроить триггер:
# Cоздайте пользовательский статус заказа, при установке которого заказ будет автоматически отменяться. Можно создать любое количество статусов.
## В RetailCRM выберите '''Настройки''' > '''Статусы''' и нажмите на кнопку '''Добавить'''. Откроется окно «Новый статус»: [[Файл:Rcrm trig103.png|600 px|none]]
## Заполните поля формы. В поле '''Символьный код''' используйте только цифры и латинские буквы без пробелов. Запишите созданный символьный код, он понадобится на следующих шагах.
# Выберите '''Настройки''' > '''Справочники''' > '''Типы доставок'''. Запишите символьные коды доставок, которые будут использоваться в триггере. В примере ниже используются коды outcity и incity.[[Файл:rcrm_trig104.png|600px|none]]
# Откройте '''Настройки''' > '''Триггеры''' и нажмите на кнопку '''+ Триггер'''. Откроется окно «Новый триггер».
#:Заполните поля:
#: '''Название'''. Название триггера, например «Отмена заказа в MeaSoft».
#: В разделе '''Событие''' нажмите на кнопку '''+ Событие''', выберите значение '''Изменение заказа''' и нажмите на кнопку '''Добавить'''.
#: В разделе '''Условие''' установите переключатель '''Редактор''' и добавьте следующий скрипт:
#:<source lang="javascript">
order.getStatus().getCode() in ["CancelMeaSoft"] and order.getDeliveryType().getCode() in ["outcity","incity"]
</source>
#:где
#* <code>CancelMeaSoft</code> — символьный код статуса заказа. Если нужно указать 2 статуса, напишите их через запятую в виде: <code>["CancelMeaSoft_1","CancelMeaSoft_2"]</code> вместо <code>["SentMeaSoft"]</code>;
#* <code>outcity</code>, <code>incity</code> — символьные коды типа доставки. Если нужно указать 1 тип доставки, напишите его в виде <code>["incity"]</code> вместо <code>["outcity","incity"]</code>.
# В разделе '''Действие''' нажмите на кнопку '''+ Действие''', выберите '''Выполнить HTTP-запрос'''. Появятся дополнительные поля настроек. Заполните их следующим образом:
#* '''Адрес''' — https://home.courierexe.ru/reintegrations/requests/cancelbystatus/retailcrm;
#* '''HTTP метод''' — '''POST''';
#* '''Передавать параметры''' — '''В теле запроса (urlencode)''';
# Нажмите на кнопку '''Добавить параметр''' 3 раза подряд и заполните появившиеся поля следующими данными:
:::{|class="wikitable"
!Параметр
!Значение
|-
|id||<nowiki>{{ order.getNumber() }}</nowiki>
|-
|key||<nowiki>{{ order.getIntegrationDeliveryData().getExtraData().deliveryApiKey }}</nowiki>
|}
::'''Примечание'''. Переносы строк не допускаются.
:6. В панели '''Действия''' нажмите '''Сохранить''', затем сохраните триггер.

:[[Файл:Новый триггер.png|600 px|none]]

Триггер настроен.

=== Отмена заказа при смене типа доставки ===

Запрос отмены предназначен для заказов, которые еще не приняты в работу: не было изменений статуса доставки, статуса корреспонденции, времени доставки.

Возможность отмены заказа есть только у курьерских служб с тарифом «Премиум» или «Максимум». По умолчанию она выключена, ее нужно включить в [[Личный кабинет курьерской службы#Параметры|личном кабинете курьерской службы]]: '''Управление ЛК''' > '''Параметры''' > '''Расширенные''' > '''Разрешить отмену и изменение заказов'''.

При отмене заказа поле '''Инфо о доставке''' получает значение '''Отменено заказчиком''', поле '''Дата доставки''' заполняется текущей датой, а в поле '''Вручил курьер''' появляется системная запись '''Отмена'''.

Чтобы настроить триггер:
# В RetailCRM выберите '''Настройки''' > '''Справочники''' > '''Типы доставок'''. [[Файл:Rcrm_trig104.png|600 px|none]]
#: Запишите символьный код типа доставки (доставок), заказы которой отправляются в MeaSoft.
# Перейдите в раздел '''Продажи''' и нажмите на кнопку '''Новый заказ'''. В разделе '''Доставка''' выберите тип доставки, заказы которой отправляются в MeaSoft, укажите город, вес и тариф.
# В разделе '''Доставка''' появится поле '''API ключ службы доставки'''. Запишите его значение. В результате у вас есть пара «символьный код типа доставки» — «API ключ службы доставки».
# Повторите действия пп. 2-3 для каждой доставки, заказы по которой отправляются в MeaSoft.
# Откройте '''Настройки''' > '''Триггеры''' и нажмите на кнопку '''+ Триггер'''. Откроется окно «Новый триггер».
#: Заполните поля:
#* '''Название'''. Название триггера, например «Отмена заказа в MeaSoft»;
#* В разделе '''Событие''' нажмите на кнопку '''+ Событие''', выберите значение '''Изменение заказа''' и нажмите на кнопку '''Добавить'''.
#* В разделе '''Условие''' установите переключатель '''Редактор''' и добавьте следующий скрипт:
#:<source lang="javascript">
changeSet.hasChangedField("delivery_type") and changeSet.getOldValue("delivery_type").getCode() in ["outcity","incity"]
</source>
#:где <code>outcity</code>, <code>incity</code> — символьные коды типа доставки. Если нужно указать один тип доставки, напишите его в виде <code>["incity"]</code> вместо <code>["outcity","incity"]</code>.
# В разделе '''Действие''' нажмите на кнопку '''+ Действие''', выберите '''Выполнить HTTP-запрос'''. Появятся дополнительные поля настроек. Заполните их следующим образом:
#* '''Адрес''' — https://home.courierexe.ru/reintegrations/requests/cancel/retailcrm;
#* '''HTTP метод''' — '''POST''';
#* '''Передавать параметры''' — '''В теле запроса (urlencode)''';
# Нажмите на кнопку '''Добавить параметр''' 2 раза подряд и потом еще столько раз, сколько у вас сопоставленных пар «символьный код типа доставки» - «API ключ службы доставки». Заполните появившиеся поля следующими данными:
:::{|class="wikitable"
!Параметр
!Значение
|-
|id||<nowiki>{{ order.getNumber() }}</nowiki>
|-
|code||<nowiki>{{ changeSet.getOldValue("delivery_type").getCode() }}</nowiki>
|-
|Cимвольный код типа доставки 1||API-ключ службы доставки 1
|-
|Cимвольный код типа доставки 2||API-ключ службы доставки 2
|}
::'''Примечание'''. Переносы строк не допускаются.
:8. В панели '''Действия''' нажмите '''Сохранить''', затем сохраните триггер.
:[[Файл:Новый триггер2.png|600 px|none]]
Триггер настроен.

=== Передача изменений заказа ===

Изменять заказ могут только курьерские службы с тарифом «Премиум» или «Максимум». По умолчанию опция выключена, ее нужно включить в [[Личный кабинет курьерской службы#Параметры|личном кабинете курьерской службы]]: '''Управление ЛК''' > '''Параметры''' > '''Расширенные''' > '''Разрешить отмену и изменение заказов'''.

Чтобы настроить триггер:
# В RetailCRM выберите '''Настройки''' > '''Справочники''' > '''Типы доставок'''. [[Файл:Rcrm_trig104.png|600 px|none]]
#: Запишите символьный код доставки (доставок), заказы которой отправляются в MeaSoft.
# Откройте '''Настройки''' > '''Триггеры''' и нажмите на кнопку '''+ Триггер'''. Откроется окно «Новый триггер».
#: Заполните поля:
#* '''Название'''. Название триггера, например «Передача изменений заказа в MeaSoft»;
#* В разделе '''Событие''' нажмите на кнопку '''+ Событие''', выберите значение '''Изменение заказа''' и нажмите на кнопку '''Добавить'''.
#* В разделе '''Условие''' установите переключатель '''Редактор''' и добавьте следующий скрипт:
#:<source lang="javascript">
changeSet.isUpdate() and
(
changeSet.hasChangedField("first_name") or
changeSet.hasChangedField("last_name") or
changeSet.hasChangedField("patronymic") or
changeSet.hasChangedField("phone") or
changeSet.hasChangedField("site") or
changeSet.hasChangedField("additional_phone") or
changeSet.hasChangedField("email") or
changeSet.hasChangedField("customer.phones") or
changeSet.hasChangedField("order_product") or
changeSet.hasChangedField("total_summ") or
changeSet.hasChangedField("delivery_date") or
changeSet.hasChangedField("delivery_time") or
changeSet.hasChangedField("payments") or
changeSet.hasChangedField("prepay_sum") or
changeSet.hasChangedField("weight") or
changeSet.hasChangedField("length") or
changeSet.hasChangedField("width") or
changeSet.hasChangedField("height") or
changeSet.hasChangedField("payments.id") or
changeSet.hasChangedField("payments.status") or
changeSet.hasChangedField("payments.type") or
changeSet.hasChangedField("payments.external_id") or
changeSet.hasChangedField("payments.amount") or
changeSet.hasChangedField("payments.paid_at") or
changeSet.hasChangedField("payments.comment") or
changeSet.hasChangedField("discount_manual_amount") or
changeSet.hasChangedField("discount_manual_percent")
)
and
order.getDeliveryType().getCode() in ["outcity","incity"]
</source>
#:где <code>outcity</code>, <code>incity</code> — символьные коды типа доставки. Если нужно указать один тип доставки, напишите его в виде <code>["incity"]</code> вместо <code>["outcity","incity"]</code>.
# В разделе '''Действие''' нажмите на кнопку '''+ Действие''', выберите '''Выполнить HTTP-запрос'''. Появятся дополнительные поля настроек. Заполните их следующим образом:
#* '''Адрес''' — https://home.courierexe.ru/reintegrations/requests/update/retailcrm;
#* '''HTTP метод''' — '''POST''';
#* '''Передавать параметры''' — '''В теле запроса (urlencode)''';
# Нажмите на кнопку '''Добавить параметр''' 3 раза подряд и заполните появившиеся поля следующими данными:
:::{|class="wikitable"
!Параметр
!Значение
|-
|id||<nowiki>{{ order.getNumber() }}</nowiki>
|-
|sum||<nowiki>{{ order.getIntegrationDeliveryData().getDeclaredSum() }}</nowiki>
|-
|key||<nowiki>{{ order.getIntegrationDeliveryData().getExtraData().deliveryApiKey }}</nowiki>
|}
::'''Примечание'''. Переносы строк не допускаются.
:5. В панели '''Действия''' нажмите '''Сохранить''', затем сохраните триггер.
:[[Файл:Новый триггер3.png|600 px|none]]
Триггер настроен.

== Проверка работоспособности интеграции ==

# Убедитесь, что выполнены все шаги [[RetailCRM#Настройка интеграции|инструкции по настройке интеграции]].
# Если используются триггеры, убедитесь, что они настроены согласно [[RetailCRM#Настройка триггеров|инструкции]].
# Создайте заказ, заполните требуемые данные.
# Нажмите на кнопку '''Сохранить''' внизу страницы, флажок '''Не отправлять данные в службу доставки''' должен быть снят.<br>Заказ должен отправиться в курьерскую службу. Если заказ отправлен без ошибок и отображается в ЛК, значит интеграция настроена.
# Если возникает ошибка, ее текст отображается наверху страницы.
:: Если это ошибка заполнения формы, исправьте внесенные данные и попробуйте отправить заказ снова. Пример ошибки: «Ошибка сервиса доставки "Курьерская служба 2008": field [receiver phone] has no valid phone number».
:: Если это ошибка ответа курьерской службы, сообщите об этом разработчику. Пример ошибки: «Служба доставки прислала ответ в неверном формате».
Текст ошибки можно увидеть через [[Личный кабинет#Отладка|отладку]] в личном кабинете. Чтобы найти свой заказ в запросах, нажмите CTRL+F и введите в строку поиска номер заказа или ориентируйтесь на время создания заказа.

Справки о налоговом резидентстве

2022-09-06T19:05:44Z

Johny:

==2023==
Справку о налоговом резидентстве ИП может получить только по прошествии 183-х дней с начала года, т.е в начале Июля. Это факт, мы даже получали соответсвующий комментарий от налоговой. Следите за обновлениями летом!

==2022==

[https://courierexe.ru/download/resident/2022/REPLY_1408920.PDF Казахстан]

[https://courierexe.ru/download/resident/2022/REPLY_1408918.PDF Беларусь]

[https://courierexe.ru/download/resident/2022/REPLY_1408921.PDF Латвия]

[https://courierexe.ru/download/resident/2022/REPLY_1408923.PDF Киргизия]

[https://courierexe.ru/download/resident/2022/REPLY_1408919.PDF Узбекистан]

[https://courierexe.ru/download/resident/2022/REPLY_1408922.PDF Таджикистан]

==2021==

[https://courierexe.ru/download/resident/2021/REPLY_1063591.PDF Казахстан]

[https://courierexe.ru/download/resident/2021/REPLY_1063595.PDF Беларусь]

[https://courierexe.ru/download/resident/2021/REPLY_1063593.PDF Латвия]

[https://courierexe.ru/download/resident/2021/REPLY_1063596.PDF Киргизия]

[https://courierexe.ru/download/resident/2021/REPLY_1063592.PDF Узбекистан]

[https://courierexe.ru/download/resident/2021/REPLY_1063594.PDF Таджикистан]

==2020==

[https://courierexe.ru/download/resident/2020/REPLY_746895.PDF Казахстан]

[https://courierexe.ru/download/resident/2020/REPLY_746896.PDF Беларусь]

[https://courierexe.ru/download/resident/2020/REPLY_746897.PDF Латвия]

[https://courierexe.ru/download/resident/2020/REPLY_746898.PDF Киргизия]

[https://courierexe.ru/download/resident/2020/REPLY_746899.PDF Узбекистан]

[https://courierexe.ru/download/resident/2020/REPLY_746900.PDF Таджикистан]

== 2019 ==

[https://courierexe.ru/download/resident/2019/REPLY_593211.PDF Казахстан]

[https://courierexe.ru/download/resident/2019/REPLY_604513.PDF Беларусь]

[https://courierexe.ru/download/resident/2019/REPLY_605887.PDF Латвия]

[https://courierexe.ru/download/resident/2019/REPLY_605888.PDF Киргизия]

[https://courierexe.ru/download/resident/2019/REPLY_605889.PDF Узбекистан]

== 2018 ==

[https://courierexe.ru/download/resident/2018/REPLY_285888.PDF Казахстан]

Кладовщик — мобильное приложение для Android

2022-05-26T08:52:46Z

Johny:

<table style = "float:right;">
<tr>
<td>
[[Файл:qr.png|thumb|200px|right]]
</td>
<td>

</td>
</tr>
</table>
Приложение '''Кладовщик''' позволяет использовать мобильный телефон как сканер штрихкодов или ТСД при работе в MeaSoft. Устанавливается на мобильное устройство или ТСД под управлением Android.

Сканер cчитывает штрихкод отправления с помощью камеры устройства и передает информацию в систему MeaSoft. Бесплатная функция.

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

Функциональность в режиме ТСД:
* прием отправлений на склад;
* просмотр информации об отправлении и плановом курьере на экране мобильного устройства;
* сканирование отправления на полку или в комплект курьера;
* выдача курьеру;
* контроль целостности заказа;
* обмен данными с системой MeaSoft.

Чтобы скачать приложение, перейдите по [https://play.google.com/store/apps/details?id=ru.measoft.courierexe_tsd ссылке] или отсканируйте код справа. В некоторых ТСД не доступен Google Play, тогда можете скачать и установить [https://courierexe.ru/download/tsd/ru.measoft.courierexe_tsd-20030-(2.0.30)-release.apk APK-файл], но не забывайте его обновлять.

Мобильный телефон должен быть подключен к той же локальной сети, что и компьютер. Требуется версия Android 4.4W и выше.

= Начало работы со сканером =

# В MeaSoft откройте пункт главного меню '''Настройка''' > '''Параметры''' и перейдите на вкладку '''Оборудование'''. <br><br>[[Файл:Параметры оборудование.png|none|400px]]<br>
# Установите флажок '''Использовать терминал сбора данных''', укажите сетевой порт (по умолчанию 8081) и нажмите на кнопку '''Подключить ТСД'''.
# Если компьютер использует несколько сетевых интерфейсов, отобразится окно выбора IP-адреса. Укажите значение и нажмите на кнопку '''ОК'''. Отобразится QR-код.
# В приложении '''Кладовщик''' нажмите '''Настройки''', далее '''Сканировать код''' и считайте QR-код с экрана компьютера.
# Сканер готов к работе. Вернитесь к выбору режимов и нажмите '''Сканер'''. Сканируйте штрихкоды, как при работе с обычным сканером.<br><br> [[Файл:ТСД выбор режима.png|none|300 px]]

= Начало работы с ТСД =

# Выполните шаги 1-4 [[#Начало работы со сканером|настройки работы сканера]].
# В приложении '''Кладовщик''' выберите режим работы '''ТСД'''. Откроется окно авторизации:<br><br>[[Файл:ТСД авторизация.png|none|300 px]]<br>
# Авторизуйтесь в приложении одним из следующих способов:
#* нажмите на кнопку '''Сканировать код'''. В офисном приложении выберите пункт главного меню '''Настройки''' > '''Пользователи''', откройте [[Пользователи|карточку пользователя]] и нажмите на кнопку '''Авторизация в ТСД'''. Отобразится QR-код, отсканируйте его мобильным приложением;
#* в полях '''Логин''' и '''Пароль''' укажите учетные данные пользователя системы MeaSoft и нажмите '''Отправить'''.
# Откроется окно выбора функций ТСД:<br><br>[[Файл:ТСД работа ТСД.png|none|300 px]]

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

Чтобы освободить лицензию, в мобильном приложении нажмите '''Выйти'''. Неактивный пользователь отключается автоматически через час после последнего действия. Если приложение на устройстве закрыто без выхода из аккаунта пользователя, рабочее место освободится автоматически через 5 минут.

Чтобы просмотреть список подключенных пользователей, в MeaSoft откройте пункт главного меню '''Настройка''' > '''Активные пользователи'''. Пользователи ТСД отображаются с соответствующей пометкой в столбце «Способ подключения».

= Настройки приема =

Чтобы перейти к настройкам приема корреспонденции, в режиме приема нажмите на [[Файл:ТСД настройки.png|25 px]] в верхнем правом углу. Откроется страница настроек:

[[Файл:ТСД настройки приема.png|none|300 px]]

'''Перенумеровывать'''. Назначить адресу новый номер в корреспонденции, если она еще не была просуммирована.

'''Игнорировать ошибки повторного сканирования'''. Не показывать ошибку при повторном сканировании корреспонденции.

'''Выдавать накладные'''. При сканировании корреспонденция выдается плановому курьеру на дату, указанную в настройке '''Дата выдачи'''.

'''Дата выдачи'''. Установите дату выдачи принимаемого отправления.

'''Крупногабарит'''. При сканировании штрихкода в карточке отправления устанавливается тип корреспонденции, соответствующий крупногабариту. Позднее при планировании логисты не назначают такие отправления пешим курьерам или малогабаритным автомобилям. Чтобы настроить тип корреспонденции для крупногабарита, в переменной '''Справочники''' > '''Переменные''' > '''Корреспонденция''' > '''Прием''' > '''Тип для крупногабарита''' выберите значение из выпадающего списка.

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

= Прием отправлений =

# Когда мобильное устройство готово к работе в режиме ТСД, в мобильном приложении нажмите на кнопку '''Прием'''.
# Нажмите на кнопку [[Файл:ТСД сканировать.png|30 px]] и отсканируйте принимаемое отправление. На экране отобразится информация об отправлении:<br><br>[[Файл:ТСД прием.png|none|300 px]]<br>
# Нажмите на кнопку [[Файл:ТСД сканировать.png|30 px]] и отсканируйте штрихкод сборки комплекта курьера. На экране отобразится уведомление о том, что отправление добавлено в сборку.
# Повторите шаги 2-3 для всех принимаемых отправлений.

В результате статус трекинга принятых корреспонденций изменится на «Получен складом».

= Выдача курьеру =

Вы можете принимать отправления и выдавать курьеру на руки одновременно. Для этого в [[#Настройки приема|настройках приема]] установите флажок '''Выдавать накладные''' и укажите дату выдачи.

В результате при сканировании отправление будет принято на склад и выдано плановому курьеру на указанную дату. Статус трекинга отправления сменится на «Выдан курьеру на доставку».

= Поиск отправлений =

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

Чтобы просмотреть информацию по отправлению, в режиме ТСД нажмите на кнопку '''Поиcк''' и отсканируйте штрихкод отправления. Страница информации выглядит следующим образом:

[[Файл:ТСД поиск.png|none|300 px]]

Список отображаемых полей:
* Номер накладной,
* Шифр,
* Плановый курьер,
* ФИО получателя,
* Город получателя,
* Адрес получателя,
* Телефон получателя,
* Плановая дата доставки и время,
* Наложенный платеж,
* Режим срочности,
* Метро,
* Город агента,
* Кол-во мест,
* Поручение,
* Вложение,
* Заказчик,
* Хранится в ячейке,
* Статус корреспонденции.

Интеграция с телефонией

2022-04-11T11:22:16Z

Johny: /* Интеграция мобильного приложения */

MeaSoft интегрируется с Asterisk — это самый популярный телефонный сервер, который не заменяет телефонную компанию, а дополняет ее.

Как это работает: вы в телефонной компании берете линии связи (номера телефонов, каналы и т. д.), можете одновременно брать разные каналы в разных компаниях (с разными тарифами, из разных регионов и т.д), можете добавлять свои, например GSM-шлюзы для экономии на звонках с помощью безлимитных или безлимитных внутри сети SIM-карт. Эти линии заводятся в сервер Asterisk, к нему подключаются ваши телефоны, он программируется — откуда куда какие линии должны быть задействованы. К нему же подключается MeaSoft, причем отдельно офисная система и курьерское приложение.

Что вы получаете:

В офисе:
* операторы звонят просто кнопкой из программы;
* журнал звонков прямо в программе, с привязкой к заказам, клиентам, вашим сотрудникам. Можно подключить записи разговоров;
* при входящем звонке программа показывает оператору, кто звонит: определяет по базе клиента (вплоть до конкретного сотрудника), курьера или получателя;
* отслеживание звонков курьеров с привязкой к заказам. Можно подключить записи разговоров;
* экономия: вы можете подключить телефоны всех ваших офисов (в том числе в разных городах) к одному серверу, и связь между ними будет бесплатной. Вы можете делать исходящие звонки через GSM-шлюзы, можете подключить номера из разных регионов, и все филиалы будут звонить в эти регионы через эти линии по локальным тарифам;
* снижение нагрузки на операторов: вы можете настроить Asterisk так, чтобы, например, он направлял звонки от клиентов или курьеров не всем операторам, и их личным менеджерам (в том числе и на мобильный телефон).

У курьеров:
* экономия: звонок от курьера через телефонию делается так, что сервер курьеру перезванивает, для курьера звонок бесплатный. Для большей экономии можно использовать GSM-шлюзы, чтобы звонок шел через SIM-карту с бесплатной связью внутри оператора курьера;
* запись разговора курьера с получателем.

У получателей:
* солидность: звонок от курьера получателю можно отправлять с вашего основного городского номера, и у получателя будет определяться фирменный номер;
* снижение нагрузки на операторов: gомимо того, что система определяет кто звонит и подсказывает это оператору, Asterisk можно настроить так, чтобы он сразу маршрутизировал звонок на курьера, если звонит получатель, заказ которого находится на руках у курьера;
* отзывы: вы можете настроить сбор отзывов после звонка о работе операторов и курьеров, и мы можем настроить их получение прямо в систему с привязкой к заказу, курьеру и т. д., наравне со сбором отзывов о доставке через [[Личный кабинет курьерской службы#Сбор отзывов|веб-сервис]].

Безопасность:
* при базовом использовании, когда вы/курьеры можете звонить, система ведет журнал, и оператор видит уведомления о том, кто звонит, сервер телефонии и его администраторы не имеют доступа ни к каким данным системы. В сервер телефонии передаются только номера телефонов, на которые нужно позвонить, вся остальная информация о звонках идет из сервера телефонии к нашей системе;
* чтобы телефония могла маршрутизировать звонки на ответственных курьеров, менеджеров клиентов и т. д., ей нужно дать доступ к этой информации — как правило, это только номера телефонов клиентов, курьеров, менеджеров и связи между ними. Данные достаточно обезличенные, могут не включать в себя названия, имена, адреса и прочее.

Asterisk выступает посредником между вами и телефонной компанией. Им пользуются многие наши клиенты и мы сами. Это позволяет нашим операторам сразу сказать «Здравствуйте, Иван», если вы звоните со своего мобильного телефона.

Без интеграции с Asterisk при звонке из мобильного приложения фиксируется только факт попытки звонка. При этом нет ни записи разговора, ни его длительности, ни статуса: дозвонился или нет. Офисное приложение при нажатии кнопки звонка вызывает программу для звонков, установленную по умолчанию в Windows — это может быть программный телефон или Skype. О дальнейшей судьбе этой попытки позвонить мы также ничего не знаем.

== Где взять сервер? ==
Сам сервер можно арендовать в ДЦ или установить у себя в офисе. Установить на него телефонию, настроить под вас и сопровождать должны специалисты. Они же помогут и в выборе сервера. Рекомендовать можем проверенных нами админов из https://southbridge.io/, впрочем, на рынке их немало.

== Интеграция мобильного приложения ==
Для осуществления звонков из мобильного приложения через сервер телефонии [https://ru.wikipedia.org/wiki/Asterisk Asterisk] используется подключение через [http://asteriskpbx.ru/display/Asterisk/Asterisk+Managment+Interface+%28AMI%29 AMI].

Включите AMI, задайте адреса, с которых можно получить к нему доступ в файле /etc/asterisk/manager.conf.

Создайте пользователя, обычно это делается в файлах /etc/asterisk/manager_custom.conf или /etc/asterisk/manager.conf.

Откройте порт в файерволе (обычно 5038, прописывается в /etc/asterisk/manager.conf) ([https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/sect-Security_Guide-Firewalls.html на всякий случай вам в помощь]).

Все подключения от клиентов на андроиде происходят с IP-адресов наших серверов: 82.202.165.93, 138.201.228.71, так что смело указывайте только их — этого требует безопасность.

Осторожно! AMI — вещь достаточно дырявая, и открытие порта на весь мир очень опасно. Тем более что через эту функцию можно за ваш счет соединить 2 произвольных номера.

Пропишите настройки подключения [https://home.courierexe.ru/extraclient/phones_settings здесь]:
* '''Адрес сервера''' — IP или доменное имя. Предполагается, что у сервера Asterisk статичный внешний IP или проброшен порт AMI, иначе ничего работать не будет;
* '''Порт сервера''' — на каком порту находится AMI;
* '''Имя пользователя''' — логин AMI, созданный в manager.conf (или manager_custom.conf);
* '''Пароль''' — пароль пользователя;
* '''Канал''' — канал, через который должен происходить звонок. Обычно выглядит как «SIP/trunk_name», где trunk_name — название транка, прописанного, обычно, в файле /etc/asterisk/sip.conf. Для старых версий драйвера SIP можно указывать «SIP/trunk_name», в этом случае номер звонящего будет подставляться в конце: «SIP/trunk_name/79001234567». Для новых версий драйвера SIP можно указывать «SIP/{NUMBER}@trunk_name», в этом случае номер звонящего будет подставляться вместо {NUMBER}: «SIP/79001234567@trunk_name»;
* '''Контекст''' — контекст обработки запроса. Обычно настраиваются в диалплане в файле /etc/asterisk/extensions.conf <spoiler text="Тут настраивается запись исходящих">В стандартной поставке Asterisk не записывает исходящие звонки от курьеров. Решение — в /etc/asterisk разместить файл кастомного диалплана [http://courierexe.ru/download/extensions_custom.conf extensions_custom.conf]. В файле в 5-й строке нужно заменить транк на тот, который используется в вашей установке. Далее в настройках подключения мобильного приложения используйте контекст «from-courier». Чтобы в CDR звонки курьеров имели номер звонящего курьера, во второй строке файла уберите «<COURIER>». Это добавлено для того, чтобы можно было отфильтровать все звонки курьеров. Для уменьшения размера файлов записей рекомендуем использовать кодек G.729</spoiler>
* '''Внутренний телефон офиса''' — внутренний номер, на который приходит звонок при выборе «Позвонить в офис». Рекомендуется в настройках Asterisk указать в этом поле номер группы менеджеров;
* '''Городской телефон офиса''' — внешний номер телефона офиса. Приложение будет звонить по сотовой сети на этот номер в случае, если не удалось послать запрос на соединение с офисом в Asterisk. Заполните это поле, даже если не вы не интегрируете приложение с телефонией, это позволит курьерам совершать звонки в офис из приложения;
* '''Префикс курьера''' — префикс, который будет добавляться к номеру вызывающего абонента;
* '''Префикс клиента''' — префикс, который будет добавляться к номеру вызываемого абонента.

Сохраните настройку и проверьте ее работоспособность: введите 2 телефона и нажмите на кнопку '''Тест'''. MeaSoft отправляет запрос на Asterisk, и он должен позвонить сначала на первый телефон, потом, после поднятия трубки, идет вызов на второй номер, и происходит их коммутация.

На этом уровне MeaSoft может зафиксировать ошибку только в адресе сервера или если указан неверный/закрытый порт. Если звонок не удался, проверьте все введенные данные, посмотрите, что происходит в Asterisk с помощью команды <code>asterisk -r</code>.

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

При осуществлении вызова сервер приложения посылает на Asterisk AMI-запрос вида:

Action: login
Username: $USERNAME
Secret: $PASSWORD

Action: originate
Channel: $CHANEL/$CALL-FROM-NUMBER
WaitTime: 30
CallerId: 0
Exten: $CALL-TO-NUMBER
Context: $CONTEXT
Priority: 1

Action: Logoff

$CALL-FROM-NUMBER и $CALL-TO-NUMBER нормируются и приводятся к международному формату +7ХХХХХХХХХХ (для России и Казахстана). Для других стран, возможно, тестирование не проводилось, в случае проблем обращайтесь, будем изучать форматирование номеров в конкретной стране.

Настройка подразумевает наличие глубоких знаний в области администрирования сервера Asterisk, поэтому убедительная просьба: если вы ими не обладаете, прежде чем звонить нам и просить помощи, обратитесь к специалисту, поддерживающему вашу телефонию, покажите ему это руководство. С очень большой вероятностью ему все будет понятно, и он все настроит за 30 минут. Наша служба технической поддержки не обладает достаточной квалификацией в данной области, и, скорее всего, мы не сможем оказать вам поддержку в этом вопросе.

== Интеграция системы с телефонным сервером ==
Интеграция офисной системы с Asterisk происходит аналогично курьерской (см. выше) с той разницей, что запросы на Asterisk идут не с единого сервера, а непосредственно с пользовательских рабочих мест, поэтому файервол на сервере телефонии нужно настраивать соответственно.

Параметры подключения нужно вводить в разделе '''Справочники''' > '''Переменные''' > '''Подключения''' -> '''Asterisk'''.

В карточках пользователей '''Настройка''' > '''Пользователи''' введите внутренние номера абонентов. У пользователя может быть несколько номеров, перечисленных через запятую. При нажатии на кнопку '''Позвонить''' программа будет соединять первый телефон из списка. При входящих звонках будет показывать сообщение при звонке на любой из номеров в списке.

== Обратные запросы от Asterisk ==
Если серверу телефонии нужно получить данные из БД при входящем звонке, он напрямую подключается к MySQL, база данных courier.

Приведем наиболее популярные задачи и их решения:

* Звонит получатель, нужно его соединить с курьером, у которого находится его заказ. Это особенно актуально, если мобильное приложение курьера звонит через офисную телефонию, у получателя определяется номер телефона офиса, и он перезванивает. Запрос ниже выдает сразу номер телефона курьера, с которым нужно соединить.

SELECT k.code, k.name, k.`phonem`, k.`phonek`
FROM contacts c JOIN givn g ON g.address=c.Source JOIN kurier k ON k.code=g.`kurier`
WHERE c.SourceCodeType=3 /*Контакты именно получателей*/
AND g.State=1 /*Статус "На руках у курьера"*/
AND c.VALUE='79161234567' /*Вот тут нормированный телефон звонящего ИМЕННО в таком формате*/

* Звонит курьер, нужно его соединить с менеджером. Запрос вернет внутренний номер менеджера курьера:

SELECT k.code, k.name, u.extPhone AS managerext
FROM contacts c JOIN kurier k ON k.code=c.Source JOIN users u ON u.`user`=k.`manager`
WHERE c.SourceCodeType=1 /*Контакты именно курьеров*/
AND c.VALUE='79161234567' /*Вот тут нормированный телефон звонящего ИМЕННО в таком формате*/

* Звонит клиент, нужно его соединить с менеджером. Запрос вернет внутренний номер менеджера клиента, а также статус клиента. Запрос очень упрощен. По-хорошему надо в первую очередь смотреть контакты, не столько привязанные к клиентам, сколько к их контактным лицам (таблица fio, код 39).

SELECT k.code, k.company, u.extPhone AS managerext, c.State
FROM contacts c JOIN clients k ON k.code=c.Source LEFT JOIN users u ON u.`user`=k.`manager`
WHERE c.SourceCodeType=2 /*Контакты именно клиентов*/
AND c.VALUE='79161234567' /*Вот тут нормированный телефон звонящего ИМЕННО в таком формате*/

* Определить просто отправление из тех, что в работе. Возвращает данные отправления, заказа и клиента:

SELECT *
FROM contacts c JOIN address a on a.code=c.Source join zakaz b on a.zakaz=b.code join clients k on k.code=b.source
WHERE c.SourceCodeType=3 /*Контакты именно получателей*/
AND a.date_put is null /*Заказ в работе, не закрытый*/
AND c.VALUE='79161234567' /*Вот тут нормированный телефон звонящего ИМЕННО в таком формате*/

Конечно, при желании можно все это объединить в один запрос и гораздо быстрее за одно действие получить информацию о том, кто звонит и что с ним надо делать. Здесь приведены только шаблонные запросы. В общих словах: таблица contacts содержит все индексированными контактные данные из большинства таблиц системы. И все обращения за поиском по телефону должны заходить именно с нее. Коды таблиц для поля SourceCodeType можно посмотреть в таблице schema.table_list.

== Записи разговоров ==
В разных конфигурациях Asteriks по-разному организуется хранение записей разговоров, поэтому чтобы их прикреплять к звонкам в системе, необходима настройка «по месту». Нужно, чтобы ваш администратор телефонного сервера предоставил FTP-доступ к хранилищу записей, и наши специалисты настроят модуль автоматизации, чтобы он привязывал ссылки на файлы на сервере к звонкам в системе.

== Устранение неполадок ==
Если при попытке совершения исходящего звонка из системы появляется ошибка «Ошибка соединения с сервером телефонии», проверьте доступность порта, указанного в настройках телефонии, с помощью стандартного компонента Windows «Клиент Telnet». Если через «Клиент Telnet» не удается подключиться к порту, обратитесь к системному администратору, отвечающему за телефонию, чтобы он проверил настройки прав доступа к указанному порту.

Руководство программиста

2022-04-01T07:50:36Z

Johny: /* Объект TExcel */

== Основные положения ==

В систему «Курьерская служба 2008» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

1. При использовании значения как параметр функции интерпретатор автоматически приводит значение к типу, необходимому функции.

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным.

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.

''Подсказка: для простого округления используется функция int()''

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding = '')- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866.

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - дополнение к заголовку, передается в виде списка параметров через запятую: 1 параметр - добавляет в заголовок SOAPAction, 2 параметр - Authorization. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в милисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel. Для работы без установленного MS Excel предусмотрен объект TDirectExcel.

'''''Ввод данных'''''

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

Close – Закрывает текущий файл.

'''''Ячейки'''''

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

'''''Строки'''''

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

RowAutoFit - Устанавливает автоматическую высоту строк.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

'''''Столбцы'''''

ColCount - Возвращает количество столбцов в листе.

AutoFit – Устанавливает автоматическую ширину столбцов.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

'''''Листы'''''

SetSheet(No) – Устанавливает номер текущего листа. Если лист с таким номером не существует - он будет создан (и все листы до него). Нумерация начинается с 1.

SetSheetName(Name) - Устанавливает название текущего листа.

SheetsCount – Возвращает количество листов в книге.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

SheetDelete(i) - Удаляет лист с номером i.

'''''Форматирование'''''

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

NumberFormat(x1, y1, x2, y2, Format) - Устанавливает формат вывода чисел в указанном диапазоне ячеек. Например, если Format='0.00' - числа будут выводиться c обязательными 2 знаками после десятичного разделителя.

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

'''''Цвета'''''

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

'''''Копи-паст'''''

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

'''''Изображения'''''

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0, width=0, height=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки, width, height (не работает для DirectExcel) - ширина и высота области рисунка в пойнтах-единицах Excel

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

'''''Вывод'''''

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр copies - количество копий, по умолчанию равен 1.

Save(filename) - Сохраняет в файл filename. Если файл существует, в основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

'''''Пример использования'''''

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{|
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «Курьерская служба 2008». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [DeliveryDateMode=0, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; DeliveryDateMode: 0 - установить план. дату доставки текущим рабочим днем, 1 - установить план. дату доставки следующим рабочим днем, 2 - установить план. дату доставки равной планируемой дате оплаты АПД; Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД).

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber) - Выполняет указанную печатную форму в объекте excel. Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

'''SelDistAddr(s)''' – Возвращает строку для вставки в select запрос, для вывода поля с упрощенным адресом. Принимает один необязательный строковый параметр - алиас таблицы из которой будет упрощаться поле address, по умолчанию "a"

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID (для провайдера iVoice - идентификатор сценария (кампании)). Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдеров BitCall и iVoice. Для BitCall по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием). Для iVoice по умолчанию подразумевается параметр 'response', при этом будет возвращен JSON с ответами абонента на заданные вопросы (в зависимости от сценария)

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл SrcPath в архив и располагает его по пути ZipPath. - ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, /*ZipPath*/) - '''параметр ZipPath временно не работает'''. Добавляет файл из строки Data в архив и располагает его по пути ZipPath. -ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

Функции общего назначения:

execsimplescript(Caption, Text) - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns]) - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. Функция возвращает количество использованных столбцов.

PrintSticker(Codes, [ToBoxes=False])

GetItemByName(Name)

GetA4Printer - возвращает имя принтера выбранного для печати документов

GetStickerPrinter - возвращает имя принтера выбранного для печати стикеров

PrintAttachPDFPage(Code, FileName, Page, Printer) - печатает страницу из вложенного файла PDF. Code - код вложения (attachment), Page - номер страницы, Printer - 0 = принтер A4, 1 = принтер этикеток.

AttachPDFToText(Code, [TextFileName]) - преобразует файл PDF из вложений в текст. Code - код вложения (attachment), TextFileName - имя текстового файла, в который записывается результат (если не указан, используется временный файл). Возвращает текст в виде строки.

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

'''ClientTown''' - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

RuleName(alias) - Выдает полный путь в дерева прав по псевдониму права.

== Объект TFieldObject ==
Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Применение языка формул ==
'''в различных контекстах системы «Курьерская служба 2008» и сопутствующих проектах'''

=== Курьерская служба 2008 ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с взведённой галкой "+ к Базовой".

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

Настройка модуля печати кассовых чеков

2022-03-18T17:27:53Z

Johny: /* Настройка чековой службы */

Модуль интеграции с фискальным регистратором (печати кассовых чеков) предназначен для обеспечения возможности взаимодействия системы MeaSoft с фискальными регистраторами. Он представляет собой [http://ru.wikipedia.org/wiki/Службы_Windows службу Windows], которая подключается к БД системы и к фискальному регистратору.

Одна установка службы поддерживает один регистратор.

MeaSoft поддерживает неограниченное количество регистраторов, в том числе и зарегистрированных на одно юридическое лицо. Чтобы подключить несколько регистраторов, установите соответствующее количество модулей интеграции с ФР.

Модуль печати кассовых чеков состоит из следующих файлов:
* CheckServiceExe.exe — исполняемый файл службы;
* CheckServiceExe.ini — конфигурационный файл;
* CheckServiceExe.log — файл журнала. Если его нет, создается при запуске службы.

= Применение =

Чековая служба нужна, если:
* установлена касса Штрих-М — для печати чеков в офисной системе и мобильном приложении курьера.
:При закрытии заказа курьером в мобильном приложении для печати чеков нужен [[Настройка модуля автоматизации|модуль автоматизации]], который будет отправлять чеки, поскольку прямой связи мобильного приложения с Штрих-М нет;
* установлена касса LIFE PAY — для ручной печати чека из офисного приложения.

Для печати чека через LIFE PAY и Штрих-Нано-Ф при закрытии заказа курьером в мобильном приложении чековая служба не нужна.

'''Примечание'''. Касса Штрих-М работает с чековой службой только при подключении через COM-порт или USB и одновременно передает данные в ОФД. При подключении через USB на компьютере настраивается виртуальный COM-порт.

= Установка чековой службы=

# Скопируйте файл CheckServiceExe.exe в любую папку на компьютере:
#* для кассы Штрих-М — на тот компьютер, к которому физически подключена касса;
#* для кассы LIFE PAY – на любой компьютер, потому что у LIFE PAY облачная фискализация.
# Создайте ярлык для файла CheckServiceExe.exe.
# В свойствах ярлыка на вкладке '''Ярлык''' в поле '''Объект''' после имени файла добавьте <code>/install</code>:[[Файл:Установка чековой службы.png|none]]
# Сохраните и запустите ярлык от имени администратора. В результате служба появится в списке служб. Для просмотра списка в контекстном меню '''Мой компьютер''' выберите '''Управление''' > '''Службы'''.
# В папке с чековой службой создайте INI-файл или загрузите шаблоны: [https://courierexe.ru/download/checkservice/lifepay/CheckServiceExe.ini LIFE PAY], [https://courierexe.ru/download/checkservice/shtrih/CheckServiceExe.ini Штрих-М].
# Откройте INI-файл, укажите [[#Настройка чековой службы |параметры]] для своей базы и сохраните изменения.
# В контекстном меню элемента '''Мой компьютер''' выберите '''Управление''' > '''Службы''', убедитесь, что режим запуска службы установлен в положение «Автоматически», и запустите чековую службу. Если установка и настройка прошли успешно, то первый чек будет сразу распечатан на кассе.

Если чек не печатается, смотрите причины в файле логов чековой службы CheckServiceExe.log. Он находится в папке чековой службы. Подробнее см. раздел «[[Устранение неполадок]]».

Можно установить несколько независимых экземпляров службы на одну систему, переименовав exe-файл. Название службы в Windows, файлы настроек и логов будут иметь соответствующие имена.

= Настройка чековой службы =
Откройте файл CheckServiceExe.ini любым текстовым редактором, например [http://ru.wikipedia.org/wiki/Блокнот_(программа) блокнотом].

В разделе <nowiki>[COMMON]</nowiki> измените или добавьте следующие параметры:

{|class="wikitable" style="width: 80%;" "background-color:#ffffff;"
!style="width: 20%;"|Параметр
!style="width: 40%;"| Штрих-М
!style="width: 40%;"| LIFE PAY
|-
|<code>Param</code><br>Дополнительные параметры фискального регистратора
|Пример: <code>Param=30, 6</code><br>Обязательный параметр, значения указываются через запятую. <br>Первое значение — пароль пользователя ФР, по умолчанию 30. Второе значение — скорость работы ФР. Чтобы узнать скорость, используйте утилиту «Тест драйвера», которая поставляется с кассой: откройте утилиту, нажмите на кнопку '''Настройка свойств''' > '''Поиск оборудования'''. Отобразится подключенный ФР и его <spoiler text="скорость работы">Принимаемые значения параметра '''Скорость порта''':<br>1 — 4800 кбит/с,<br> 2 — 9600 кбит/с,<br> 3 — 19200 кбит/с,<br> 4 — 38400 кбит/с,<br> 5 — 57600 кбит/с,<br> 6 — 115200 кбит/с.<br>Значение параметра скорости должно совпадать с установленным режимом самого фискального регистратора. По умолчанию он настроен на скорость 115200, однако иногда этот параметр необходимо уменьшить для повышения стабильности работы регистратора. Также были случаи сброса скорости в положение 4800 пользователями, что возможно при включении ФР с зажатой кнопкой промотки чековой ленты (см. [http://courierexe.ru/download/ext_manual/Shtrih_user_manual.pdf руководство пользователя]). Таким образом, начальная настройка в этом режиме исключит вероятность отказа системы из-за ошибочного сброса настройки в ФР. Скорость работы в ФР можно задать в утилите «Тест драйвера» в окне «Настройка свойств» кнопкой '''Установить параметры'''.<br>Например, чтобы установить для модуля настройки подключения к ФР следующие параметры: пароль доступа — 30, скорость порта — 4800, укажите строку: <br> Param=30, 1</spoiler>.
|Пример: <code>Param=91defdc4556fc182680982e1b2am8d6f, 79011111111,,64</code><br>Необязательный параметр. Если значения указаны в [[Фирмы#Добавление фискального регистратора|фискальном регистраторе]], можно оставить строку в таком виде: <code>#Param=</code><br>Первое значение — 32-значный АПИ-ключ из ЛК LIFE PAY.<br>Второе значение — номер телефона без +, на который зарегистрирован ЛК LIFE PAY. <br>Третье значение — пустое.<br>Четвертое значение — агентский признак, если есть.
|-
|<code>Port</code><br>Номер [http://ru.wikipedia.org/wiki/Последовательный_порт COM-порта] фискального регистратора. Если регистратор подключен через [http://ru.wikipedia.org/wiki/USB USB-порт], драйвер эмулятора порта все равно создает виртуальный COM-порт, номер которого устанавливается в его свойствах (в [http://ru.wikipedia.org/wiki/Диспетчер_устройств диспетчере устройств]), а также номер порта меняется в зависимости от разъема USB, к которому подключено устройство.
|Пример: <code>Port=5</code><br>Обязательный параметр.
|Пример: <code>Port=1 </code><br>Необязательный параметр, можно указывать значение 1.
|-
|<code>CashRegister</code><br><rspoiler text="Код фискального регистратора">Чтобы его узнать, выберите в главном меню системы пункт '''Справочники''' > '''Фирмы''', откройте карточку фирмы, на которую зарегистрирован фискальный регистратор, перейдите на закладку '''Устройства''', убедитесь, что в выпадающем списке выбрано значение '''Фискальные регистраторы'''. В списке фискальных регистраторов вы увидите код. Если запись для регистратора еще не создана или вы планируете установить дополнительную кассу, добавьте новый ФР.</rspoiler> в базе данных.
|colspan="2" |Пример: <code>CashRegister=2 </code> <br> Обязательный параметр.<br> <spoiler text="Что еще можно указать">Можно указывать наборы обслуживаемых ФР двумя способами:
* через запятую или тире или их комбинации указать несколько кодов;
* условие SQL-запроса. Например <code>AND cr.DeviceType=3</code> для всех доступных ФР LIFE PAY.

Тогда они все будут обслуживаться одним объектом подключения к ФР. Что это значит: для Штрих-М у объекта открыт COM-порт при старте, и поменяться он не может. Все чеки пойдут в один ФР. Для LIFE PAY — в созданный объект передается поле '''Серийный номер''', откуда он берет авторизацию, т.о. чеки могут отправляться в различные аккаунты. Главное, что тип кассы у всех ФР должен быть один — служба не сможет переключиться например с LIFE PAY на ApiShip.</spoiler>
|-
|<code>ServerName</code><br>Имя или IP-адрес сервера, на котором находится БД MeaSoft. Сервер должен быть доступен по сети с компьютера, к которому подключена касса.
|colspan="2" |Пример: <code>ServerName=srv01 </code> <br> Обязательный параметр.
|-
|<code>DatabaseName</code><br>Имя базы данных (по умолчанию «courier»)
|colspan="2" |Пример: <code>DataBaseName=courier</code> <br>Обязательный параметр.
|-
|<code>UserName</code><br>Имя пользователя базы данных
|colspan="2" |Пример: <code>UserName=check</code> <br>Обязательный параметр. Пользователя check нужно создать для определения запросов чековой службы, для этого обратитесь в техподдержку.
|-
|<code>Password</code><br>Пароль пользователя базы данных
|colspan="2" |Пример: <code>Password=password </code> <br>Обязательный параметр.
|-
|<code>DBPort</code><br>Порт базы данных
|colspan="2" |Пример: <code>DBPort =3306 </code> <br>Обязательный параметр. По умолчанию 3306. Проверить порт можно в любом ярлыке офисной программы.
|-
|<code>Device</code>
|1 — ФР Штрих-М (по умолчанию),<br> 2 — чековый принтер Штрих-М (протокол Epson ESC/P)
|3 — сервис фискализации LIFE PAY <br> 9 - WebKassa
|-
|<code>AgentFlags</code><br>Флаги тега 1057 для передачи в кассу при агентском чеке
|colspan="2" | Пример: <code>AgentFlags=4</code><br>Обязательный параметр, если курьерская служба — платежный агент. Чтобы не передавать признаки платежного агента (если в кассе нет этого признака), укажите 0. Если параметр не указан, передается значение по умолчанию 4. <spoiler text="Возможные значения">
* 1 — банковский платежный агент,
* 2 — банковский платежный субагент,
* 4 — платежный агент,
* 8 — платежный субагент,
* 16 — поверенный,
* 32 — комиссионер,
* 64 — агент.
</spoiler>
|-
|<code>PrintKurier</code>
|colspan="2" |1 — печать ФИО курьера на чеке.
|-
|<code>PrintSeller</code>
|colspan="2" |1 — печать заказчика на чеке.<br> Если включено, печатается юр. наименование, ИНН и телефон клиента.<br>В [[Клиенты и партнеры#Реквизиты|карточке клиента]] на вкладке '''Реквизиты''' должно быть заполнено поле '''Полное название'''.<br> Этот параметр никак не связан с тегами фискального документа 1225 и 1226 и просто выводит текстом на бумагу дополнительный текст там, где это возможно.
|-
|<code>PrintCashier</code><br>Печатать имя кассира на чеке (тег 1021). По умолчанию 1.
|colspan="2" |1 — кассир берется из строки чека,<br>0 — не печатается,<br> другое число — код нужного сотрудника.<br>Можно писать подзапрос вида <code>if(a.cl=1, 5, 6)</code>.
|-
|<code>EmailPriority</code>
|colspan="2" |1 — отправка чека по e-mail приоритетнее, чем SMS.
|-
|<code>AddStr</code>
|colspan="2" | Пользовательская строка, которая печатается на всех чеках.
|-
|}

= Настройка ФР Штрих-М =
[[Файл:ShtrihTableList.png|thumb|100px|right]]
'''Внимание.''' Для использования программы «Тест драйвера» нужно остановить службу «CheckService».

=== Обрезка чека ===
Обрезка чеков настраивается в таблице 1 фискального регистратора, параметр «Отрезка чека». Установите значение 1 чтобы ФР полностью отрезал каждый чек, или 2, чтобы он частично надрезал, чтобы чеки все-равно были лентой. Наша система не посылает на ККМ команду обрезки чека во избежание двойной обрезки.

=== Отчет по секциям ===
[[Файл:ShtrihZReportSect.png|thumb|100px|right]]
В системе предусмотрено разнесение различных фискальных операций по секциям фискального регистратора. По-умолчанию суточные отчеты (X и Z-отчеты) отображают общие суммы по всем секциям. В ФР есть возможность сделать разбивку этих отчетов по секциям. Для этого в таблице 1 фискального регистратора, параметр «Тип суточного отчета» установите в значение 1.

=== Проверка корректности регистрации в ОФД ===
<gallery style="float: right" mode="nolines">
Номер фиск документа.png
Читаем отчет регистрации.png
</gallery>
Для удовлетворения большинства потребностей наших клиентов в правильной фискализации в соответствии с 54-ФЗ, необходимо иметь [[Оборудование#Фискальный регистратор|ФР]] с фискальным накопителем (ФН) поддерживающие версию фискальный документ (ФД) версии 1.05. Так же необходимо зарегистрировать ФР в ОФД с признаком агента (тег 1057), так как курьерские службы обычно выступают в качестве платежного агента. Для соблюдения всех этих требований нужно обратиться в организацию, обслуживающую ваш фискальный регистратор с соответствующей просьбой. В некоторых случаях для поддержки может понадобиться перепрошивка ФР, замена ФН, перерегистрация в ОФД.
После этих операций, можно убедиться, что все признаки, нас интересующие, установлены корректно. Для этого сначала нужно узнать номер документа фискализации. В программе «Тест драйвера» слева откроем раздел «11. ФН», в закладках «Фискализация ФН», нажмем кнопку «Запрос итогов фискализации» (см. скрин-шот). В результирующем отчете видим номер фискального документа о фискализации.
Затем идем на закладку «Данные», Вводим номер документа, ставим галку «Показ. номера тегов», и нажимаем «Прочитать документ». В результирующем тексте убеждаемся в использовании версии ФД 1.05 — теги 1209 «Версия ФФД» и 1189 «Версия ФФД ККМ» должны иметь значения 2, тег 1057 «Призн. плат. агента» — должен быть, вероятно, 4 (это регистр битов, значение «4» соответствует установленному биту 2 «Платежный агент»).

'''Внимание'''. Данные фискального документа хранятся в фискальном накопителе 30 дней, после этого срока посмотреть документ регистрации (перерегистрации) в ФН будет невозможно.

=== Проверка корректности передачи тегов в ОФД ===
<gallery style="float: right" mode="nolines">
Shtrih LastDoc.png
Shtrih check tags.png
</gallery>
Убедиться в корректности передаваемых в ОФД значений тегов можно следующим образом: Сначала узнаем номер фискального документа — его можно посмотреть в чеке (как бумажном, так и электронном), или в приложении «Тест драйвера» в разделе «11. ФН», в закладках «Состояние ФН», нажмем кнопку «Запрос статуса ФН» и посмотрим «Номер последнего ФД» (см. скрин-шот). Далее на закладке «Данные» введем этот номер в поле «№Док.», и нажмем «Прочитать документ». В результирующем тексте убеждаемся в отправке тегов 1008, 1057, 1073, 1171, 1215 и прочих (см. скрин-шот).

Теги 1225 и 1226 (Наименование и ИНН поставщика) поддерживаются Штрих-М в прошивке от 24.10.2018 и версией чековой службы от 19.03.2019

К сожалению, эти передаваемые данные далеко не всегда отображаются в бумажном и/или электронном чеках, это зависит от самого ФР и/или ОФД соответственно. Однако по данной инструкции мы можем убедиться, что со своей стороны передали все данные, необходимые для соответствия 54-ФЗ.

= Удаление службы=
Для корректного удаления службы запустите исполняемый файл CheckServiceExe.exe с параметром командной строки <code>/uninstall</code>.

= Примечания =
Поскольку при запуске служба открывает подключение к фискальному регистратору, и использует его все время своей работы, другие программы (например «Тест драйвера» и т. д.) при попытке подключения выдадут ошибку «Невозможно открыть порт, он используется другим приложением». Чтобы избежать этого, остановите службу модуля на время использования других программ.

= Устранение неполадок =
1. В случае сбоя работы кассы ошибку можно посмотреть в файле CheckServiceExe.log

2. Ошибки условно можно разделить на 3 категории:
{|
!Ошибка
!Симптомы
!Возможные причины
!Способы устранения
|-
|Нет связи с сервером
|Касса не печатает, в логе сообщения вида «Unknown MySQL server host ''» или «Can’t connect to MySQL server on…».
|Неверно настроено подключение к серверу, не работает сервер, сеть.
|Проверить настройки подключения в файле CheckServiceExe.ini, проверить доступность сервера с этого компьютера.
|-
|Нет связи с фискальным регистратором
|Касса не печатает, в логе сообщения вида «Нет связи код: −1, Режим: 0, Подрежим: 0»
|ФР Выключен, ФР подключен не к тому разъему, ФР настроен не на ту скорость
|Проверьте, что ФР включен, подключен к компьютеру, именно в тот порт, в котором он настраивался. Попробуйте отключить службу чеков, открыть программу «Тест драйвера», выполнить поиск оборудования. Если она находит ФР — сравнить настройки подключения, найденные тестом драйвера с тем, что прописано в CheckServiceExe.ini. В единичных случаях проблема может заключаться в драйвере переходника COM-USB, попробуйте удалить этот переходник в диспетчере устройств windows, и попросить его поискать устройства заново.
|-
|Некорректная работа фискального регистратора.
|Касса печатает заголовок чека, потом ошибку, потом надпись «Чек аннулирован», и так бесконечно по кругу.
|Аппаратная ошибка ФР, некорректный чек, сформированный системой.
|Если текст ошибки, который печатается на чеке (он же сохраняется и в лог-файл) содержит информацию об [http://ru.wikipedia.org/wiki/ЭКЛЗ ЭКЛЗ] (например «ЭКЛЗ: Неверные дата или время код: 168, Режим: 3, Подрежим: 0») — нужно обратиться в компанию, с которой у вас заключен договор о поддержке кассы, сообщить им текст ошибки. В остальных случаях — обратиться в службу поддержки MeaSoft для выяснения причины и ее устранения.
|-
|Ошибка при формировании отчета без гашения (X-отчет)
|Касса печатает X-отчет бесконечно по кругу. В протоколе работы чековой службы выдается сообщение «Команда не поддерживается в данном режиме код: 115, Режим: 6, Подрежим: 0».
|В кассовом аппарате не установлены дата и время.
|Необходимо через драйвер ФР установить текущую дату и время, затем cохранить настройку. В остальных случаях — обратиться в службу поддержки MeaSoft для выяснения причины и ее устранения.
|}

= Печать чеков =

=== При предоплате ===
Если продавец передаёт предоплаченный товар курьерской службе, чек на предоплату формирует продавец. Курьерская служба должна оформить чек на передачу товара, так как ККТ обязано использовать лицо, осуществляющее расчёты с покупателем (п. 1 ст. 4.3 54-ФЗ).

Поскольку передача заказа в зачёт предоплаты относится к расчётам и этим занимается курьер, пробить кассовый чек должен именно он.

В таком случае покупатель получает два чека: первый чек выдаётся, когда клиент вносит предоплату, а второй чек — когда он получает товар. Подробнее см. [https://astral.ru/articles/ofd/12791 в статье].

=== В офисном приложении ===
Чековая служба не запрашивает печать бумажного чека, если заказ доставлен курьером: бумажный чек тратит бумагу, и если бумага закончится, то печать чеков остановится. А эту бумагу курьер все равно получателю отдать не сможет.

Если клиент находится перед вами, в офисе, то чек печатается — соблюдается одно из условий:
* вы отмечаете доставленным отправление, у которого выбрана доставка в пункт выдачи, совпадающий с текущим ответственным филиалом;
* вы принимаете оплату за доставку заказа от заказчика, в этом случае вы вносите платеж на вкладке '''Заказы''' в карточке заказа.

=== LIFE PAY: отличия между чеками в офисном и мобильном приложении ===
{|class="wikitable" align="none" style="width: 80%; background-color:#ffffff;
!style="width: 20%|Отличие
!style="width: 40%|Офисное приложение
!style="width: 40%|Мобильное приложение
|-
|Авторизация. Тег <code>login</code>||Общий номер телефона<br><br>Его можно указать в ini-файле чековой службы или 2-м параметром в поле '''Cерийный номер''' в карточке ФР в программе.<br>Чекопечатающее устройство (ЧПУ) в этом случае не предполагается, а авторизация нужна.||Мобильный телефон курьера<br><br>По этому параметру LIFE PAY определяет, на какой чековый принтер отправлять копию чека.
|-
|Имя кассира. Тег <code>cashier_name</code>||Параметр <code>PrintCashier</code> в ini-файле<br><br>Если включено, передается ФИО сотрудника, инициировавшего печать.<br>Офисные сотрудники обычно официально трудоустроены, поэтому поле заполняется.||Не указывается<br><br>В большинстве случаев курьеры не оформлены официально, показывать налоговой их не нужно.
|-
| Режим печати чека. Тег <code>mode</code>.||Печать на бумаге на ФР и отправка SMS или по электронной почте<br><br>В офисе предполагается, что это самовывоз — покупатель стоит перед вами, и вы пробиваете чек и сразу из ФР его отдаете покупателю||Отправка SMS или по электронной почте<br><br>Когда курьер доставляет заказ, он печатает бумажный чек на ЧПУ. Бумажные чеки в отсутствие ЧПУ в офисе [[#Печать чеков в офисном приложении|не печатаются]]. Фискализировать чек, не отправляя его ни на бумагу, ни на ФР, ни по почте/SMS, невозможно, это аппаратно не позволяет делать ФР. Можно на уровне ОФД отключить SMS, если они не нужны, и вам достаточно бумажного чека из ЧПУ.
|}

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

= Ошибки фискализации =

== Ошибка программирования реквизита 1226 ==
Ошибка тега 1226 означает, что не был передан ИНН поставщика.

ИНН передается, если:
# Передан признак агента.
# ИНН поставщика указан в карточке клиента в Measoft или в контейнере вложения в [[API#Описание элементов для оформления заказа|API-запросе]] (параметр <code>suppINN</code>).
# Наименование поставщика указано в карточке клиента в Measoft (поле '''[[Клиенты и партнеры#Реквизиты|Полное наименование]]''') или в контейнере вложения в API-запросе (параметр <code>suppcompany</code>).

Приоритет имеет значение, указанное в контейнере вложения.

== Ошибка программирования реквизита 1171 ==
Ошибка тега 1171 означает, что не был передан номер телефона поставщика.

Номер телефона поставщика должен быть указан в контейнере вложения [[API#Описание элементов для оформления заказа|API-запросе]] (параметр <code>suppphone</code>), карточке отдела или карточке клиента MeaSoft, на вкладке '''Реквизиты''' в поле '''Тел'''.

Приоритет имеет значение, указанное в контейнере вложения.

Честный ЗНАК

2022-02-02T13:33:20Z

Johny: /* Как передавать коды в MeaSoft */

С 2019 года началось внедрение единой национальной системы маркировки «Честный ЗНАК». В настоящее время маркировка специальным кодом [https://mertech.ru/blog/vse-o-skanerah-shtrih-koda/datamatrix-kod-markirovki Data Matrix] обязательна для табачной продукции, шуб, обуви, и других групп товаров. Полный список товаров, подлежащих маркировке, можно посмотреть [https://xn--80ajghhoc2aj1c8b.xn--p1ai/business здесь].

Каждая единица товара должна быть зарегистрирована производителем или реализатором в России в системе маркировки «Честный ЗНАК» и промаркирована полученным кодом.

Коды Data Matrix учитываются при всех операциях с товарами и передаются в ОФД при фискализации чеков.

= Формат кода Честного Знака =
Документы, которые мы используем при получении информации о форматах кодов: [https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf Честный ЗНАК], [https://www.atol.ru/blog/struktura-koda-markirovki/ Атол], [https://docs.google.com/document/d/1ec2ufRcd716ewjKVJTyxAv4e4sEh6jRWsqwQhr2FWQo/edit# Штрих-М]. Однако, все они неполные и быстро устаревают. Здесь мы постараемся описать то, что сами знаем о кодах маркировки на текущий момент.

Живой код состоит из следующих частей:
{| class="wikitable"
|-
! Пример !! Длина !! Номер байта начала !! Описание
|-
| 01 || 2 || 1 || Разделитель, всегда 01
|-
| 02900002317701 || 14 || 3 || Код, присвоенный товару. Комбинация из 14 цифр.
|-
| 21 || 2 || 17 || Разделитель, всегда 21
|-
| k3LInNbH_oG0Q || 13 || 19 || Уникальный серийный номер товара. Комбинация латинских букв и цифр. Присваивается оператором информационной системы маркировки или одним из участников оборота
|-
| || 1 || 32 || непечатаемый ASCII-символ с кодом 29
|-
| 91 || 2 || 33 || Разделитель, пока встречались значения 91 и 93
|-
| EE06 || 4 || 35 || Проверочный ключ. Генерируется оператором системы маркировки
|-
| || 1 || 39 || непечатаемый ASCII-символ с кодом 29
|-
| 92 || 2 || 40 || Разделитель, пока встречались только 92
|-
| YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= || 44 или 88 || 42 || Проверочный код (криптохвост). Комбинация из 88 (для обуви) или 44 (для текстиля и автошин) символов — букв, цифр, специальных знаков. Заканчивается (всегда?) знаком «=» (равно)
|}

Обратите внимание:
* Система Measoft игнорирует — не принимает и не хранит — символы с кодом 29. Они у нас просто подразумеваются по номерам позиций, где должны быть. При передаче кодов к нам эти символы нужно убирать.
* Значения разделителей (01, 21, 91, 92, 93 и др) могут встречаться и внутри полей данных. Нельзя считать, что если встретилось 91, значит после него проверочный ключ.
* При использовании ККМ с ФФД 1.2 необходимо иметь полный код маркировки для возможности фискализации. До версии 1.2 криптохвост необязателен.

= Как передавать коды в MeaSoft =

Формат кода можно посмотреть в [https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf рекомендациях Честного ЗНАКА].

В коде Data Matrix используется специальный управляющий символ непечатаемый ASCII-символ с кодом 29. В MeaSoft необходимо передать значения БЕЗ этих символов.

Код должен быть <rspoiler text="полным">До ФФД 1.2 код мог быть неполным. Начиная с ФФД 1.2 (на который все компании, реализующие маркированные товары обязаны были уже перейти) фискальный регистратор не принимает код маркировки без криптохвоста</rspoiler>, с криптохвостом.

Коды можно передавать следующими способами:
* по [[API]] в теге <code>governmentCode</code>.
* в Личном кабинете при оформлении [[Личный кабинет клиента#Добавление товара|заказа вручную]] или при [[Личный кабинет клиента#Загрузка реестра Excel|загрузке реестра Microsoft Excel]];
* в карточке корреспонденции в товарных вложениях;
* [[Импорт баз данных|импорт]] файла Microsoft Excel в MeaSoft.
Если код неизвестен, укажите знак вопроса «?». Курьер должен будет отсканировать QR-коды при вручении товара для учета в фискальном документе.

= Работа с маркированными товарами =

Работа с маркированными товарами ведется как в рамках складского учета, так и без него.

Для сканирования кодов Data Matrix требуется 2D-сканер. Его может заменить наше приложение для смартфона на ОС Android [[Мобильное приложение кладовщика для Android|'''Кладовщик''']].

=== Товары со складским учетом ===

Для указания наличия маркировки у товара в карточке справочника [[Модуль складского учета#Карточка номенклатуры|'''Номенклатура''']] используется флажок '''Есть QR-код'''. Если флажок установлен:
* в одной строке товарных вложений может передаваться только одна единица товара;
* в товарных вложениях поле '''Код товарной номенклатуры''' автоматически заполняется значением «?», если не указано значение кода.

Чтобы вести учет движения товаров по коду маркировки, в карточке справочника '''Номенклатура''' установите флажок '''Учет серийных номеров'''. В этом случае любая операция движения товара, начиная с приема на склад, сопровождается сканированием кода маркировки.

=== Товары без складского учета ===

При передаче заказа в MeaSoft продавец может указать значение кода маркировки или знак «?». При вручении заказа мобильное приложение для курьера контролирует выдачу товаров и не позволяет закрыть заказ, если не отсканирован нужный код.

= Доставка маркированных товаров =

Значения кодов передаются в мобильное приложение курьера.

Мобильное приложение контролирует движение маркированных товаров следующим образом:
* если код маркировки передан, при полной доставке код сканировать не надо, при возврате требуется отсканировать код возвращаемой позиции;
* если указан знак «?», то требуется сканировать код как при полной доставке, так и при частичной;
* при закрытии заказа недоставленным сканировать не требуется.

Мобильное приложение распознает отсканированный код как Data Matrix при одновременном выполнении условий:
# Длина кода более 30 символов.
# В строке есть сочетание «001D».

Значение отсканированного курьером кода передается в MeaSoft.

= Вывод проданных товаров из оборота =

Участник оборота маркированных товаров обязан передавать информацию о выбытии таких товаров из оборота в систему маркировки «Честный ЗНАК».

C 6 августа 2021 года вступил в силу новый формат фискальных документов версии 1.2. Он автоматизирует передачу данных в «Честный ЗНАК»: касса после формирования чека отправляет уведомление о выбытии маркированного товара из оборота. В ответ приходит подтверждение выбытия или сообщение об ошибке, касса его распечатывает.

Формат обязателен для компаний, который торгуют маркированной продукцией и дополняет действующие ФФД 1.05 и 1.1. Подробнее о том, как перейти на ФФД 1.2, см. [https://www.garant.ru/ia/opinion/author/rusinova/1475197/ по ссылке].


Чтобы просмотреть используемые в заказах коды, в [[Личный кабинет клиента#Отслеживание исходящих заказов|Личном кабинете]] в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Коды «Честный ЗНАК»'''.

Чтобы получить список проданных маркированных товаров, в личном кабинете в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Вывод из оборота «Честный ЗНАК»'''. На основании данных кассовых чеков сформируется файл в формате XML.

<spoiler text="См. также">
[https://честныйзнак.рф/barcode/?category=3 Проверка сканера на сайте «Честный ЗНАК»]<br>
[[Модуль складского учета#Карточка номенклатуры|Карточка номенклатуры]]<br>
[[Мобильное приложение курьера для Android]]<br>
[[Мобильное приложение кладовщика для Android]]
</spoiler>

Устранение неполадок

2022-01-26T13:28:42Z

Johny: /* Печатает «иероглифы» */

==Ошибки при запуске системы==

Если при запуске MeaSoft появляются ошибки или работают не все вкладки программы, проверьте системный формат даты в параметрах Windows. Краткая запись даты должна соответствовать формату dd.mm.yyyy.

== Не отображаются заголовки таблиц и элементы карточек ==

Ошибка может быть связана с работоспособностью шрифта MS Sans Serif в операционной системе Windows 10 после обновления 1803.

Решение:
# В редакторе реестра из раздела '''HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Fonts''' удалите переменные '''MS Sans Serif 8,10,12,14,18,24''', '''MS Sans Serif 8,10,12,14,18,24 (текущий масштаб)'''.
# Добавьте переменную '''MS Sans Serif''' со значением <code>sserifer.fon</code>.
# Перезапустите MeaSoft.

== Неверно указана единица измерения ==

При формировании документов в MS Word (например, для клиентов и/или курьеров) в связи с некорректной работой программы MS Word возможно появление сообщения «Неверно указана единица измерения», а также «зависание» системы.

Способы решения:
*для MS Office 2003 — установите service pack 3 или скачайте и установите [http://www.courierexe.ru/download/office2003-KB912201-RUS.exe обновление];
*для MS Office 2007 — скачайте файл [http://www.courierexe.ru/download/WWINTL.DLL WWINTL.DLL] и замените им файл в папке С:\Program Files\Microsoft Office\Office12\1049.

== Неверные подписи в строке состояния ==

ДАННАЯ ПРОБЛЕМА УСТРАНЕНА В СИСТЕМЕ НАЧИНАЯ С ВЕРСИИ 2008.0.0.342

При отображении в строке состояния (нижняя строка главного окна) вместо количества записей в таблице – названий пунктов меню (Справочники, Номенклатура, и т.д.) проблема, скорее всего, кроется в наличии запущенного приложения
*Abbyy Lingvo (эта программа некорректно получает доступ к ресурсам других программ). Решение – закрыть Lingvo.
*TrueSuite. Решение – Удалить программу.
*Windows 8. Решение - обновить систему.
*TeamViewer (эта программа интегрирует в приложение кнопку QuickConnect в заголовок окна). Решение - отключить функцию QuickConnect в свойствах программы.

== Разница времени между сервером и рабочей станцией ==
'''ВНИМАНИЕ!''' 24.09.2014 Microsoft [http://support.microsoft.com/kb/2998527 выпустила обновление KB2998527], меняющее часовой пояс обратно на UTC+3 с дальнейшим переходом на зимнее время!
Необходимо убедиться в правильной установке обновления на сервер и все рабочие станции. После установки проверьте корректность отображаемого времени!

*[http://www.courierexe.ru/download/msupdate/2998527/Windows8.1-KB2998527-x86.msu Windows 8.1 32bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows8.1-KB2998527-x64.msu Windows 8.1 64bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows8-RT-KB2998527-x86.msu Windows 8 32bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows8-RT-KB2998527-x64.msu Windows 8 64bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows6.1-KB2998527-x86.msu Windows 7 32bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows6.1-KB2998527-x64.msu Windows 7 64bit]

*[http://www.courierexe.ru/download/msupdate/2998527/Windows8.1-KB2998527-x64.msu Windows server 2012 R2]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows8-RT-KB2998527-x64.msu Windows server 2012]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows6.1-KB2998527-x64.msu Windows server 2008 R2 64bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows6.0-KB2998527-x86.msu Windows server 2008 32bit]
*[http://www.courierexe.ru/download/msupdate/2998527/Windows6.0-KB2998527-x64.msu Windows server 2008 64bit]
*[http://www.courierexe.ru/download/msupdate/2998527/WindowsServer2003-KB2998527-x86-RUS.exe Windows server 2003 32bit]
*[http://www.courierexe.ru/download/msupdate/2998527/WindowsServer2003-KB2998527-x64-RUS.exe Windows server 2003 64bit]

Для Windows XP Microsoft не выпускает обновления (поддержка этой ОС закончена), поэтому рекомендуем просто установить часовой пояс UTC+03:00.

Если программа не запускается со следующим сообщением: "Разница времени между сервером и данной рабочей станцией составляет более 30-ти минут! Проверьте системные время и дату, а так же часовой пояс!", проверьте правильность системного времени на сервере и на рабочей станции. Если время совпадает, значит проблема в разнице часовых поясов. Сравните часовые пояса на сервере и на рабочей станции. Часовой пояс определяется смещением от [http://ru.wikipedia.org/wiki/Среднее_время_по_Гринвичу GMT]([http://ru.wikipedia.org/wiki/Всемирное_координированное_время UTC]) и наличием перехода на летнее/зимнее время. Если на компьютере включены автоматические обновления и версия операционной системы поддерживается Microsoft, исправление часового пояса должно произойти автоматически. Если обновления выключены, установите вручную, скачав обновление по адресу: http://support.microsoft.com/kb/2570791
Для популярных версий обновления можно скачать здесь:

*[http://www.courierexe.ru/download/msupdate/2570791/WindowsXP-KB2570791-x86-RUS.exe Windows XP sp3 32bit]
*[http://www.courierexe.ru/download/msupdate/2570791/WindowsServer2003.WindowsXP-KB2570791-x64-ENU.exe Windows XP sp3 64bit]
*[http://www.courierexe.ru/download/msupdate/2570791/Windows6.0-KB2570791-x86.msu Windows Vista sp2 32bit]
*[http://www.courierexe.ru/download/msupdate/2570791/Windows6.0-KB2570791-x64.msu Windows Vista sp2 64bit]
*[http://www.courierexe.ru/download/msupdate/2570791/Windows6.1-KB2570791-x86.msu Windows 7 32bit]
*[http://www.courierexe.ru/download/msupdate/2570791/Windows6.1-KB2570791-x64.msu Windows 7 64bit]

Если у вас неподдерживаемая ОС (например Windows XP sp2), [http://windows.microsoft.com/ru-RU/windows/help/learn-how-to-install-windows-xp-service-pack-3-sp3 установите последний сервис-пак], а уже потом обновление. Также есть «запасной» вариант — измените часовой пояс на другой город с нужным смещением от GMT. В этом случае обратите внимание еще и на переход на летнее/зимнее время в выбранном городе.

При изменении часового пояса меняется системное время компьютера. Проверьте его правильность.

== Печатает «иероглифы» ==

Проблема связана с тем, что по умолчанию большинство драйверов принтеров при отправке текста на печать передают в принтер только сам текст, без шрифта. При этом используются шрифты, заложенные в принтер фирмой-производителем. В большинстве случаев пользователь этого не замечает, потому что в Россию поставляются официальные «русские» редакции принтеров с заложенными шрифтами с поддержкой кириллицы. Однако иногда приходится сталкиваться и с неадаптированными устройствами. Как правило это старые принтеры, произведенные в 90-х годах, а так же современные принтеры некоторых производителей, например Kyocera.

В общем случае устранение проблемы сводится к отключению шрифтов устройства в драйвере принтера. В некоторых драйверах эта функция так и называется — «Использовать шрифты устройства» (Use device font), в некоторых — «Оптимизация печати» (Print optimization), а также фирменные названия вроде «Magic print».

Наиболее часто эта проблема встречается с принтерами '''Kyocera''', поэтому ниже представлена инструкция по отключению шрифтов принтера для этого производителя.

:1. Откройте окно свойств принтера. <spoiler text="Как?">Открытие свойств принтера зависит от операционной системы.
:Для Windows 10:
# Откройте '''Пуск''' > '''Параметры''' [[Файл:Winsettings.png|16px]] > '''Устройства''' > '''Принтеры и сканеры''', выберите принтер и нажмите на появившуюся кнопку '''Управление'''.
# Выберите пункт '''Свойства принтера'''.
:Для Windows 7:
# Перейдите '''Пуск''' > '''Устройства и принтеры''' и двойным щелчком откройте нужный принтер. Откроется окно очереди печати.
# В открывшемся окне выберите пункт меню '''Принтер''' > '''Свойства'''.
:Для Windows XP:
:: Откройте '''Пуск''' > '''Настройка''' > '''Принтеры''', в контекстном меню принтера '''Свойства'''</spoiler>
:2. В открывшемся окне нажмите на кнопку '''Настройка'''.
:3. В открывшемся окне в меню слева выберите пункт '''Изображение''' и нажмите на кнопку '''Шрифты'''.
:4. Установите галку "Отключить шрифты устройства".
:5. Закройте открытые окна и перезагрузите компьютер.

Для принтера '''HP LaserJet XXXX''', как правило, нужно изменить драйвер:

# Зайдите на [https://support.hp.com/ru-ru/drivers/printers сайт производителя], скачайте драйвер PCL 6 для своей операционной системы.
# Установите драйвер.
# Откройте окно свойств принтера.
# Вверху окна перейдите на закладку '''Дополнительно'''.
# В выпадающем списке '''Драйвер''' у вас указано '''НР LJ XXXX PCL5e'''. Последовательно нажмите '''Сменить''', '''Далее''', '''Установить с диска''', '''Обзор''', укажите, где сохранены скачанные драйверы, '''ОК''', выберите драйвер '''НР LJ XXXX PCL6''', '''Далее'''.
# Перезагрузите компьютер.

== Иероглифы в программе ==

Если в MeaSoft отображаются иероглифы вместо русского текста, то скорее всего в системе установлен шрифт MS Sans Serif без символов кириллицы. Для устранения неполадки [https://www.courierexe.ru/download/fonts.zip скачайте] корректные шрифты, установите их из карточки шрифта в архиве или скопируйте с заменой в папку с шрифтами Windows, как правило это C:\Windows\Fonts.

Если эти действия не помогли, проверьте в настройках языка и региональных стандартов системы Windows ('''Панель управления''' > '''Язык и региональные стандарты'''), что на вкладке '''Форматы''' выбран русский язык для формата и на вкладке '''Дополнительно''' выбран русский как текущий язык программ, не поддерживающих Юникод.

Если русского языка нет в настройках языка и региональных стандартов, скачайте и установите русский языковой пакет для вашей операционной системы. Скачать можно [https://support.microsoft.com/ru-ru/help/14236/language-packs здесь].

== Устранение неполадок при отправке электронной почты ==

Проблема возникает редко и не все ошибки отправки почты в старых версиях системы (до версии '''2008.00100''') отображаются пользователю в виде сообщения об ошибке SMTP протокола.

При возникновении неполадки, связанной с отправкой электронной почты из системы, выполните пошаговую проверку настроек:
# Сетевые экраны некоторых антивирусов (например, Avast) могут блокировать почтовый трафик от недоверенных программ (почтовых клиентов), поэтому отключите на время настройки почты антивирус и его сетевой экран.
# Проверьте [[Настройка глобальных параметров#Настройка подключения к почтовому серверу|глобальные настройки]] почтовых параметров (имя сервера и порт SMTP) в меню '''Справочники''' > '''Переменные'''. Изменение этих параметров вступает в силу только после перезапуска MeaSoft.
# Проверьте [[Настройка глобальных параметров#Пример настройки для Яндекс.Почты|параметры настройки]] почтового соединения в меню '''Настройка''' > '''Параметры''' на вкладке [[Настройка_параметров_рабочего_места#Подключения|'''Подключения''']]. Чтобы использовать настройки почтового соединения, отличного от глобальной настройки (в переменных), установите флажок '''Использовать локальные настройки почты'''.
# Проверьте корректность электронных адресов получателей счетов в карточке клиентов на вкладке '''Реквизиты'''.
# Проверьте имя компьютера рабочей станции (хоста), на котором установлено приложение MeaSoft. Имя не должно содержать русских символов.
# В меню '''Настройка''' > '''Пользователи''' откройте карточку пользователя и в поле '''E-mail''' проверьте наличие адреса отправителя.
# Отправьте тестовое почтовое сообщение с компьютера рабочей станции для конкретного почтового аккаунта из почтового клиента, например из Outlook Express, The Bat.
# Проверьте настройку протокола шифрования SSL для бесплатных почтовых сервисов mail.ru и yandex.ru в меню <mparam text="Почтовый сервер" code="SMTPProtocol"></mparam>.

'''Внимание!''' Шифрование для SMTP-протокола поддерживается начиная с версии MeaSoft 2008.0.0.496. Чтобы проверить текущую версию, перейдите в '''Справочник''' > '''Переменные''' > '''Система''' > '''Загруженная версия'''.

Распространенные ошибки при неправильных настройках почтового аккаунта в программе:

# Ошибка отправки письма: Ошибка подключения к серверу. 553 5.7.1 Sender address rejected: not owned by auth user.
# Не все письма были отправлены. Описание ошибок: Ошибка подключения/авторизации на почтовом сервере "smtp.yandex.ru"/"smtp.mail.ru".

== Ошибки печати кассовых чеков ==

Ошибки и способы устранения описаны в статье [[Настройка модуля печати кассовых чеков#Устранение неполадок|о настройке модуля печати чеков]]

== Неверно работает COM-сканер штрихкодов ==
Выставить настройки интерфейса сканера:

Битрейт: 9600

Данные: 8 бит

Проверка четности: "Маркер" (можно "Чет")

Стоповый бит: 1

== Существенное замедление работы программы при загрузке реестра Excel ==
Заключается в увеличении времени обработки, которое требуется программе для загрузки реестра с заказами.

Причина: пустые строки в файле Excel после основного содержимого до определенного значения, в рассматриваемом примере — до 140 строки. Программно определить, что строки «ненастоящие», невозможно, поэтому MeaSoft пытается последовательно обработать и загрузить каждую строку. Количество строк таблицы может быть велико, поэтому процесс загрузки существенно замедляется. На рисунке ниже показан подобный файл реестра:

[[Файл:Nepoladka_Excel.png|500px|none]]

Чтобы понять, есть ли пустые строки в реестре, откройте его и нажмите CTRL + END. Активная ячейка покажет конец данных листа.

Чтобы удалить пустой диапазон между строкой этой ячейки и последней строкой данных реестра:
# Нажмите на заголовок строки, следующей за последней строкой реестра. Вся строка будет выделена.
# Нажмите сочетание клавиш SHIFT + CTRL + END, чтобы выбрать диапазон от выделенной строки до конца данных.
# На выделенной области вызовите контекстное меню и выберите '''Удалить'''. Последней строкой документа станет строка реестра.
# Нажмите '''Сохранить'''.

Загрузите сохраненный файл в MeaSoft.

== Ошибочное представление данных для Excel отчетов ==

В некоторых устаревших версиях MS Office, например Excel 2010 версии 14.0.7015.1000 (любой разрядности) наблюдается ошибочное представление значений даты в ячейках для Excel отчетов (вместо даты отображается 5-значное цифровое значение). Эта ошибка решается в рамках обновлений версии Office 2010 до 14.0.7177.5000, например.

Оборудование

2022-01-21T07:06:30Z

Johny: /* Настройка фискальных регистраторов */

== Аппаратные требования к рабочей станции ==
* Работа под управлением ОС Windows 32/64 Bit: Win7, Win8; Win10. Мы пока не можем гарантировать стабильную работу системы на Windows 11 из-за "сырости" самой ОС.
* Установленный и активированный пакет Microsoft Office 2007 или выше '''кроме «Office 2010 Starter»'''.
* Процессор: любой, удовлетворяющий рабочим требованиям линейки ОС Windows.
* Оперативное запоминающее устройство (ОЗУ): от 2 Gb и выше.
* Запоминающее устройство HDD: от 30 GB и выше.
* Сетевой интерфейс: проводной/беспроводной Ethernet интерфейс.
* Монитор: диагональ, обеспечивающая разрешающую способность экрана не менее 1024*768 пикселей.
* Периферийные порты ввода-вывода USB, RS232 (при необходимости наличия таковых): для подключения периферийного оборудования (сканер штрихкодов, <br>фискальный регистратор, термопринтер).
* Клавиатура, манипулятор мышь.

== Выбор сервера для системы ==

=== Выбор серверного оборудования ===
Система MeaSoft нетребовательна к аппаратным ресурсам сервера.

Что касается '''производительности''', то для небольшой компании, человек 10 в офисе, как правило, производительности бытового ноутбука, установленного в качестве сервера, будет более, чем достаточно. То есть серверную часть можно установить на любую машину, за которой работает пользователь. Для компаний до 20 сотрудников мы рекомендуем использовать бытовой компьютер, но «назначенный» сервером, то есть чтобы он стоял отдельно работал круглосуточно, и им никто не пользовался в качестве рабочей станции. Для компаний более 20 человек — лучше использовать именно серверное оборудование, хотя у нас есть установка, где на бытовом Core i3 одновременно работает 80 человек.

'''Объем диска''': Изначально при установке БД занимает около 1 Gb. Далее она увеличивается в зависимости от использования. Если компания доставляет 20000 отправлений в месяц, через 3 года объем базы будет 10 Gb с одной оговоркой: Больше всего места в БД занимают файлы, такие, как архив отсканированных накладных, отправленные по почте отчеты и счета, и т. д. Здесь, если компания использует эти возможности, она за год может накопить и 100 и 200 Gb. Так же необходимо учитывать некоторый объем свободного места, необходимый для создания резервных копий, а так же для работы самой ОС.

Самое главное требование системы к серверу — это его '''надежность'''. Надо понимать, что при поломке сервера приостановится работа всей компании. В худшем случае — можно потерять данные, введенные с момента последней резервной копии. Для сокращения возможных рисков, нужно стараться, по возможности, делать сервер максимально надежным:

* Мы не рекомендуем устанавливать сервер на ноутбук, так как его форм-фактор предполагает некоторую степень мобильности. Есть соблазн взять его куда-то с собой. А при перемещении велик риск его потери, кражи, его можно уронить и разбить. Еще один фактор низкой надежности ноутбуков — они часто умирают от пролитого на них чая/кофе/пива.
* Мы не рекомендуем устанавливать серверную часть на компьютер, за которым работает пользователь. Здесь главный фактор риска — это заражение компьютера вирусами, которые пользователь, по неграмотности, скачивает из интернета, приносит на флешках и т. д. Антивирус никакой от этого не спасает.
* Мы рекомендуем устанавливать на серверный компьютер [https://ru.wikipedia.org/wiki/RAID Raid-1] массивы для снижения вероятности выхода из строя/потери данных в случае поломки жесткого диска. Однако нужно понимать, что это тоже не панацея: жесткие диски достаточно часто выходят из строя все одновременно, например, при поломке блока питания, когда напряжение «пробивает» через него и приводит к выгоранию всех компонентов компьютера, В случае стихийных бедствий и несчастных случаев (прорывы в трубах, например), или просто от того, что 2 HDD одной модели, купленные одновременно имеют одинаковый ресурс наработки на отказ.
* Мы рекомендуем устанавливать [https://ru.wikipedia.org/wiki/Источник_бесперебойного_питания ИБП] на сервер для предохранения его от скачков напряжения в сети и/или аварийного завершения работы при отключении питания.
* Мы рекомендуем использовать специализированное серверное оборудование, так как оно по определению гораздо надежнее, вплоть до резервирования блоков питания. Но такое оборудование достаточно дорогое, и его использование носит исключительно рекомендательный характер.

Некоторые наши клиенты не удовлетворяются вышеизложенными рекомендациями по выбору серверного оборудования и просят нас предоставить формальные требования к серверу. Вот они:

1. Работа под управлением ОС Windows 2012 Server R2;<br>
2. Процессор: многоядерный, удовлетворяющий требованиям ОС;<br>
3. Оперативное запоминающее устройство (ОЗУ): от 4 GB;<br>
4. Запоминающее устройство HDD: от 360 Gb, Raid-1;<br>
5. Сетевой интерфейс: проводной Ethernet интерфейс — 100 Mbit.;<br>
6. Монитор, с разрешением минимум 1024*768;<br>
7. Клавиатура microsoft минимум 103 клавиши;<br>
8. Мышь оптическая;<br>
9. Колонки активные минимум 2 Вт;<br>
10. Коврик для мыши силиконовый :-)<br>

=== Выбор серверной операционной системы ===
Серверная часть MeaSoft работает практически на любой операционной системе. Исключение — модуль интеграции с внешними системами.

При выборе ОС нужно рассмотреть все плюсы и минусы. Обычно выбор стоит между Windows и Linux.

Windows — платная система. Серверная Windows стоит 40-45 т.р. Система прекрасно работает, например, на Windows 7 (желательно только не домашнюю версию), которая стоит в разы меньше. Ограничение на количество подключений к ней не имеет отношения к нашей системе.

Linux — «бесплатная» система. Почему в кавычках? Потому что стоимость владения им гораздо выше: для администрирования системы linux необходим системный администратор с глубокими познаниями этой ОС, а такие специалисты стоят в 2 раза дороже, чем администраторы Windows.

Таким образом даже «дорогая» серверная Windows окупается за пару месяцев. Linux можно выбирать только в том случае, если в вашей компании и так уже работает несколько системных администраторов Linux, которые смогут решать возможные проблемы с ней. Наша компания оказывает необходимую для работы системы помощь в администрировании windows-серверов, но с linux эта функция полностью ложится на заказчика. Почему мы говорим, что должно быть несколько администраторов в случае с Linux? Потому что в случае увольнения единственного администратора, как правило, компанию ждут времена несчастий, пока не найдется новый ТОЛКОВЫЙ системный администратор.

Резюме: Выбирайте Linux только в том случае, если вы точно уверены в том, что делаете. В противном случае — только Windows.

=== Размещение сервера ===
Для классической архитектуры системы, когда офис-склад консолидированы в одном месте, мы рекомендуем размещение сервера в офисе. То есть в точке максимального использования системы. Это обеспечивает максимальную скорость и надежность. При этом при необходимости удаленного доступа к системе — достаточно, имея внешний статичный IP-адрес, «пробросить» порт 3306 на сервер.

В последнее время все больше популярность приобретает размещение сервера «в облаке». На самом деле формально — это, конечно, не [https://ru.wikipedia.org/wiki/Облачное_хранилище_данных облако] в широком понимании, а [https://ru.wikipedia.org/wiki/VPS сервер], физический или виртуальный, находящийся в дата-центре. При выборе такого варианта установки программы следует учесть ряд факторов:
* '''Скорость доступа''' Наша система очень чувствительна к скорости доступа. Некоторые операции могут вызывать несколько обращений к серверу, и увеличение времени одного обращения на несколько миллисекунд существенно снижает общую производительность системы на рабочем месте. При размещении сервера в дата-центрах Европы, например, скорость доступа ([https://ru.wikipedia.org/wiki/Ping ping]) из Москвы составляет 50-60 мс. Это — на грани возможности использования программы. При размещении в дата-центре того же города, где находятся пользователи, время доступа — порядка 3-5 мс. Для сравнения — доступ по локальной сети — менее 1 мс.
* '''Надежность интернет-канала''' Нужно понимать, что в случае размещения сервера в интернете система не будет работать у вас в офисе и/или на складе в случае отсутствия доступа в интернет. Желательно обеспечить резервирование канала, причем, желательно, не 3G-«свистком» (см. следующие 2 пункта).
* '''Пропускная способность интернет-канала''' При разработке системы мы стараемся минимизировать объемы информации, передаваемые между рабочим местом и сервером. Но если доступ происходит через интернет, на одном канале работает несколько человек, на котором работает и программа и телефоны, а кто-то смотрит видео в ютубе, а кто-нибудь еще придумает пользоваться торрентами — работа остановится.
* '''Стабильность интернет-канала''' При доступе к серверу не должны теряться пакеты. Если на канале происходят потери — программа будет закрываться с сообщением о том, что произошла потеря соединения с сервером. Потери пакетов можно проанализировать командой ping -t <имя_сервера, например ya.ru>.
* '''Надежность дата-центра''' Теоретически — в дата-центре обеспечивается резервирование и электропитания, и каналов передачи данных. Естественно, в них стоят и промышленные климатические системы, поддерживающие заданную рабочую температуру всего оборудования. Но на практике часто бывает, что сервер оказывается недоступным на время от нескольких минут до нескольких дней. Техподдержка (если ее телефон вообще отвечает, а часто как раз в эти моменты она не работает — либо потому, что телефония работает на том же канале, который у них и «упал», либо потому, что тысячи пользователей серверов, обнаружив неполадки, начали им одновременно звонить) скажет «да, в вашем сегменте технические неполадки, мы устраняем», и больше сделать вы ничего не сможете. В случае, если сервер стоит у вас в офисе — вы сами принимаете моментальные меры. Вплоть до того, что можно вынуть из сгоревшего сервера жесткий диск, подключить к другому компьютеру, и восстановить работу системы.
* '''Стоимость''' При размещении на linux-VDS серверах стоимость на текущий момент — [http://firstvds.ru/products/vds_vps_hosting 600-900 руб/мес], Windows — [https://masterhost.ru/service/hosting/vps/ 4000 руб/мес]. По поводу выбора ОС читайте соответствующий раздел этой же статьи.

Отсюда вывод:
Мы рекомендуем устанавливать сервер «в облаке» только в случае сильно распределенной структуры компании. Когда максимальную скорость и надежность нужно обеспечить множеству удаленных пользователей, а не в одном конкретном месте.

== Доступ для установки системы ==

Для установки системы программисту MeaSoft требуется доступ к вашему серверу с правами администратора. В процессе установки потребуется устанавливать службы, запускать и останавливать их, а также производить запуск приложений от имени администратора. Доступ можно предоставить одним из способов:
* по [https://remontka.pro/microsoft-remote-desktop/ RDP] — передайте нам IP-адрес сервера, порт (если он отличается от стандартного), логин и пароль для подключения;
* через [https://www.teamviewer.com/ru/info/remote-desktop/ TeamViewer] — установите и запустите программу на сервере и передайте нам ID и пароль подключения.

== Рекомендованное периферийное оборудование ==

=== Сканер штрихкодов ===
Рекомендуются к приобретению сканеры, официально ввезенные в вашу страну, адаптированные для местного рынка, имеющие здесь официальных поставщиков.

Мы рекомендуем:
* Zebex Z-3000 (CCD-сканер) — дешевый;
* Honeywell (Metrologic) 5145 Eclipse — лазерный;
* Honeywell (Metrologic) DS6707 — image, позволяет сканировать 2D-штрихкоды;
* Honeywell (Metrologic) 1202g Voyager BT — радиосканер, позволяет сканировать на расстоянии от компьютера.

Рекомендуются к приобретению сканеры с типом подключения USB HID.

Если вы определились с моделью сканера, то тип подключения не играет существенной роли: наша программа позволяет работать с любой из списка поддерживаемых моделей (проводной или беспроводной). Выбор интерфейса, скорее всего, зависит от наличия и доступности соответствующего порта на компьютере пользователя (так, интерфейс RS-232 предполагает наличие COM-порта, а интерфейс KBW, как правило, PS/2). Очевидным является тот факт, что наиболее универсальным будет сканер, работающий через интерфейс USB (USB HID).

Проводной или беспроводной сканер имеет такое же примерно значение, как проводная или беспроводная мышь: если вам нужно работать удаленно от управляющего устройства (компьютера), то для этого стоит выбирать беспроводную модель. Все беспроводные модели сканеров (обычно работающие через технологию Bluetooth) имеют аккумуляторные батареи и зарядные устройства, которые часто выполнены в виде базовой станции (приемно-передающего устройства) с функцией зарядки переносной части сканера.

При выборе сканера обратите внимание на то, что при типе подключения USB HID (рекомендуется) или «разрыв клавиатуры» сканер требует некоторой настройки. [[#Подключение и настройка сканеров штрихкодов|В разделе ниже]] приведены программирующие листы для различных моделей сканеров. Если вы покупаете сканер не из списка, для которого есть программирующий лист, будьте готовы к тому, что потребуется создание такого листа. Для его создания нужно полное руководство по программированию конкретного сканера на русском или английском языках. С этим часто бывают проблемы, если вы покупаете сканеры с доставкой из Китая — они, как правило, настолько китайские, что у них нет ни документации, ни сайта производителя. В таком случае остается уповать только на везение.

=== Термопринтер ===
Поддерживаются любые термо- и термо-трансферные принтеры.<br>
Рекомендуется термопринтер Zebra ZD410 — у него ширина печатающей головки 60 мм, поэтому ленту такой же ширины сложно вставить неправильно. Очень прост в обслуживании и заправке ленты. <br>
'''ВНИМАНИЕ!''' При покупке следует учитывать, что термопринтеры не комплектуются USB-шнуром и этикетками, поэтому их необходимо приобрести отдельно. Рекомендуем этикетки размером 58×40 мм.

=== Весы ===
Поддерживаются весы фирмы «МЕРА», которые поддерживают протоколы «ОКА» или «9 байт» или «Mera Avto». По нашим сведениям этот протоколы ОКА и Mera Avto поддерживают те весы, у которых есть цифровая клавиатура 0-9. Но лучше — уточняйте у продавца. Протокол «9 байт» в силу своей низкоуровневой работы с COM-портом может не работать через USB-переходники.<br>
Рекомендуем весы Мера ВП-3/30 — небольшие, точные, не дорогие.<br>
При покупке весов обратите внимание на то, что они могут подключаться к COM-порту, который отсутствует на многих компьютерах. Для весов существуют провода в USB-порт, эмулирующие COM-порт. Так же в продаже имеются переходники, а так же платы расширения компьютеров, позволяющие добавить COM-порты.
Инструкцию по настройке и подключению весов смотрите в этой статье ниже.

=== Фискальный регистратор ===
В рамках 54-ФЗ поддерживается и рекомендуется работа с сервисом удаленной фискализации LIFE PAY.

Поддерживаются все фискальные регистраторы фирмы «Штрих-М»

Рекомендуется ШТРИХ-LIGHT-ФР-К (cамый бюджетный)

При покупке ФР обратите внимание на то, что они могут подключаться к COM-порту, который отсутствует на многих компьютерах. Для них существуют провода в USB-порт, эмулирующие COM-порт. Также в продаже имеются переходники и платы расширения компьютеров, позволяющие добавить COM-порты.

=== Банковский POS-терминал ===
[https://ru.wikipedia.org/wiki/POS-%D1%82%D0%B5%D1%80%D0%BC%D0%B8%D0%BD%D0%B0%D0%BB POS-терминал].
Мобильное приложение поддерживает интеграцию с сервисами IBox, LIFE PAY, а также поддерживается работа с независимыми POS-терминалами.

=== Планшетный сканер ===
Применяется для сканирования ведомостей с подписью, после чего полученные документы вы можете прикрепить в программе к соответствующей корреспонденции.<br>
Рекомендуются сканеры с автоматической подачей.<br>
При выборе устройства обратите внимание на следующие характеристики:
* Скорость сканирования;
* Наличие функции обнаружения подачи двух листов;
* Двухстороннее сканирование;
* Количество сканирований до отказа.

=== Монитор ноутбука/нетбука/компьютера ===
Рабочее место пользователя для работы с MeaSoft должно оснащаться монитором с разрешающей способностью экрана не менее 1024*768 пикселей. При работе на портативных устройствах, таких как нетбуки, у которых разрешение ниже рекомендуемого, в экран могут не помещаться некоторые окна.

=== Штрихкодовая линейка-угол ===
Штрихкодовая линейка-угол применяется для обмера габаритов отправления. Обмер можно производить при приеме корреспонденции на склад (F10 на вкладке «Заказы»). Каждое деление (1, 5 или 10 миллиметров) линейки промаркировано своим штрихкодом. Прикладывая товар к линейке и сканируя штрихкод, соответствующий краю товара, получаем размеры. Чтобы включить поддержку штрихкодированной линейки, нужно в окне приема, нажать кнопку «Настройки» и установить галку «Включить поддержку штрихкодированной линейки». Для работы с линейкой удобнее использовать лазерные сканеры, у них полоса считывания наводится точно на нужный штрихкод. Реализована поддержка производителя [http://cortes.ru/shtrihcode/barcodeline.php Кортес]. Перед покупкой нужно проверять модель на совместимость с системой. Система поддерживает следующий формат ШК:<br>
Длина ШК 7 символов, начинается всегда на «29», например: 291XXXX, 292XXXX, 293XXXX<br>
где: XXXX — значение в милиметрах, 3-й знак — направление измерения от 1 до 3, то есть координата (длина, ширина, высота).

=== Терминал сбора данных ===
Терминал сбора данных (ТСД) под управлением Android может работать совместно с MeaSoft как сканер штрихкодов. Для этого установите на ТСД наше приложение [[Мобильное приложение кладовщика для Android|Кладовщик]] и в настройках приложения выберите режим сканера '''Аппаратный сканер'''.

== Подключение и настройка сканеров штрихкодов ==
MeaSoft поддерживает все виды [http://ru.wikipedia.org/wiki/Сканер_штрихкода сканеров штрихкодов], поэтому при выборе сканера следует учитывать особенности штрихкодов, которыми заказчики маркируют корреспонденцию. В частности, контактные светодиодные сканеры можно использовать для считывания штрихкодов длиной не более 5-7 см (в зависимости от модели сканера), а для двухмерных штрихкодов необходим image-сканер.

При подключении в разрыв клавиатуры или в порт USB в режиме эмуляции разрыва клавиатуры требуется небольшая дополнительная настройка сканера. Для этого существуют специальные программирующие листы (см. ниже) для разных моделей сканеров, на которых напечатаны штрихкоды в определенной последовательности. Просканируйте их в том порядке, в котором они расположены на листе. Как правило, для сканеров одной фирмы подходят одни и те же штрихкоды.
В результате этих действий при каждом сканировании перед штрихкодом вставляется определенный префикс, наличие которого для программы является признаком того, что данная последовательность символов введена с помощью сканера. Для использования в качестве префикса в программе зарезервирована клавиша с буквой «ё», что накладывает некоторое ограничение: невозможно ввести с клавиатуры символы «ё», «Ё», «`», «~».

В данном разделе приведены программирующие листы для популярных моделей сканеров штрихкодов. Если в этом списке не оказалось модели вашего сканера, попробуйте использовать лист от другой модели того же производителя. Сообщите, пожалуйста, нам, мы внесем изменения в список моделей, для которых подходит этот лист. Если никакой лист не подошел — сообщите, пожалуйста, об этом нам, мы подготовим лист для вашего сканера.

{| class="wikitable" style="width: 60%
!style="width: 30%;"|Бренд
!style="width: 70%;"|Модель
|-
|Argox
|[https://www.courierexe.ru/download/scaner/Argox.doc ArgoScan 8000/8110/8120/8150/8250/8310/8312, argox as-8020cl (usb))]
|-
|Champtek
|[https://www.courierexe.ru/download/scaner/Champtek.doc Champtek]
|-
|Cino
|[https://www.courierexe.ru/download/scaner/Cino.doc F680BT]
|-
|Cipherlab
|[https://www.courierexe.ru/download/scaner/Cipherlab_1021_(simple).doc 1021 (simple)]<br>[https://www.courierexe.ru/download/scaner/Cipherlab_1021_(simple)_and_back.doc 1021 с переключением обратно]<br>[https://www.courierexe.ru/download/scaner/Cipherlab_1560,_1562,_1070_(bluetooth).doc 1560, 1562, 1070 (bluetooth)]
|-
|Metrologic/Eclipse/Honeywell/Motorola/Symbol/Youjie
|[https://www.courierexe.ru/download/scaner/Honeywell_Xenon_1900.doc Xenon 1900, Voyager 1202g, YJ4600]<br>[https://www.courierexe.ru/download/scaner/Metrologic,_Eclipse,_Honeywell,_ms9520,_ms9540.doc MS5145, MS9520, MS9540, HH440]<br>[https://www.courierexe.ru/download/scaner/Symbol_ls1203,_LS2208.doc LS1203, LS2208] (подходит для li4278, Zebra DS2278)<br>[https://www.courierexe.ru/download/scaner/Symbol_ds6707.doc DS6707]<br>[https://www.courierexe.ru/download/scaner/honeywell_1452g.docx Honeywell Voyager 1452G]<br>[https://www.courierexe.ru/download/scaner/honeywell_1472g.docx Honeywell 1472g]
|-
|PayTor
|[https://www.courierexe.ru/download/scaner/Paytor%20DS%201009.docx DS 1009]
|-
|Proton
|[https://www.courierexe.ru/download/scaner/Proton.doc Proton]
[https://www.courierexe.ru/download/scaner/Proton_2.doc IMS3190, беспроводной)]
|-
|Datalogic
|[https://www.courierexe.ru/download/scaner/PSC,_Datalogic_QS2500.doc PSC, Datalogic QS2500]<br>[https://www.courierexe.ru/download/scaner/qd2100.doc QD2100]<br>[https://www.courierexe.ru/download/scaner/qd2100.doc QD2100]
[https://www.courierexe.ru/download/scaner/QuickScanMobile.doc Mobile: QM2100, M2]
|-
|Scanport
|[https://www.courierexe.ru/download/scaner/Scanport_T600.bmp T600]
|-
|Zebex
|[https://www.courierexe.ru/download/scaner/Zebex_4.bmp Zebex]
|-
|Godex
|[https://www.courierexe.ru/download/scaner/godex.doc GS550U]
|-
|Mercury
|[https://www.courierexe.ru/download/scaner/mercury.doc CL-200]<br>[https://www.courierexe.ru/download/scaner/Mercury_1100PL.docx 1100PL]
|-
|Если у вас китайский безымянный (беспроводной?) сканер, попробуйте этот лист
|[https://www.courierexe.ru/download/scaner/Vioteh.doc Vioteh VT2208R, Dudian CT980N, bp8150s, Heroje B120G]
|-
|Vioteh
|[https://www.courierexe.ru/download/scaner/VT2205_VT2209.docx VT2205 VT2209]
|-
|Heroje
|[https://www.courierexe.ru/download/scaner/Heroje_H018.doc H018]
|-
|Производитель Китай под российским брендом АТОЛ.<br>
Cканер не рекомендуется к покупке. Атол выпускает несколько разных версий сканера под одной моделью SB1101. К сожалению, не все модели поддаются настройке.
|[https://www.courierexe.ru/download/scaner/Atol_SB_1101.docx SB 1101]<br>[https://www.courierexe.ru/download/scaner/Atol_SB_1103.docx 1103]
|-
|Radall
|[https://www.courierexe.ru/download/scaner/Radall_RD-h8_2d.docx RD-h8 2d]
|-
|NETUM
|[https://www.courierexe.ru/download/scaner/NETUM_W6.docx W6]
|-
|DBS
|[https://www.courierexe.ru/download/scaner/DBS_HC-3208SR.docx HC-3208SR (Подходите также к МSC-3208 WEC2D V.2)]
|-
|Winson
|[https://www.courierexe.ru/download/scaner/Winson_WNL_WNC_6003_6083.docx WNL/WNC 6003, 6083, 5083]
|-
|Global-pos
|[https://www.courierexe.ru/download/scaner/GP-9400B.docx Global-pos GP-9400B]
|-
|Mertech
|[https://courierexe.ru/download/scaner/Mertech_cl-2300.docx CL-2300]
|-
|Bluetooth-кольцо
|[https://courierexe.ru/download/scaner/GP-1901B.docx GP-1901B]
|-
|}


'''Примечание'''. Для некоторых беспроводных моделей сканеров штрихкодов перед началом работы требуется обязательно выполнить привязку базовой станции сканера с переносным мобильным считывателем — отсканировать наклейку штрихкода на базовой станции переносной частью сканера. В частности, этот алгоритм касается сканеров фирмы Zebex.

Cписок '''неподдерживаемого системой оборудования''':
* CT10 Barcode Scanner (Производитель CILICO Electronics Co., Ltd Китай);
* Аlanda 2.4G Barcode Scanner (производитель Китай).
* Birch bd — 388 iiib (производитель Китай);

Это оборудование не позволяет установить требуемый префикс для работы с MeaSoft. Список далеко не полный.

'''Мы рекомендуем покупать сканеры, официально ввезенные в Россию, адаптированные для российского рынка, имеющие здесь официальных поставщиков.'''

При выборе сканера обратите внимание на то, что при типе подключения USB HID (этот режим рекомендуется) или «разрыв клавиатуры» сканер требует некоторой настройки. В разделе описания выше приведены программирующие листы для различных моделей сканеров. Если вы покупаете сканер не из списка, для которого уже есть программирующий лист, будьте готовы к тому, что потребуется создание такого листа. Для его создания нужно полное руководство по программированию конкретного сканера на русском или английском языках. С наличием инструкции очень часто возникают проблемы, если вы покупаете сканеры с доставкой из Китая — они, как правило, настолько не адаптированы к работе, что у них нет ни документации, ни сайта производителя. В таком случае остается уповать только на везение.

Если ваш новый сканер не поддерживается нашей системой, можно попытаться выяснить, может ли он работать в режиме эмуляции COM-порта. Наличие возможности работы в таком режиме — последний шанс использовать купленное оборудование:
# Переведите сканер в режим USB virtual COM по инструкции.
# Установите бесплатные драйверы COM-порта Nuvoton.
# В MeaSoft программе выберите '''Настройка''' > '''Параметры''' > '''Оборудование''' > '''Использовать COM-сканер''', укажите номер виртуального COM-порта, созданного драйвером (см. в диспетчере устройств Windows).
Обратите внимание, что при переключении сканера в другой USB-порт может меняться номер COM-порта, и настройку программы нужно делать заново.

== Настройка весов ==

=== Общие сведения ===
MeaSoft поддерживает работу с различными видами весов. На данный момент подключение всех видов весов к компьютеру осуществляется как через COM-порт, так и USB. В случае подключение через USB, на компьютер необходимо установить драйвер USB-COM конвертера. Драйвер поставляется производителем весов, либо переходника, через который вы подключаете весы. После установки драйвера в «Диспетчере устройств» вашего компьютера должен появиться новый COM-порт, через который и будет осуществляться дальнейшее взаимодействие с весами. Обратите внимание: При подключении USB-шнура к другому USB-разъему компьютера зачастую происходит изменение номера COM-порта, который привязан к шнуру. В этом случае потребуется указание в программе нового номера порта.

Весы нужно подключить к компьютеру, и активировать использование весов в программе в разделе «Настройка» — «Параметры» — «Оборудование». Там нужно установить флажок '''Использовать весы''', выбрать тип весов и указать нужный COM-порт.

После успешного подключения весов откройте карточку корреспонденции (или окно «Прием» в заказах). Возле поля «Масса» появится кнопка весов. Для того, чтобы программа показывала вес с весов кнопка должна быть нажата.

Особенности настройки различных моделей весов приведены ниже.

=== Настройка весов МЕРА ===
Для связи с весами мера система использует протоколы «9байт», «ОКА» и «MERA-AUTO» и «Сетевые».

Какой выбрать:
* 9байт — установлен в весах по умолчанию. Он позволяет передавать нестабильный вес, что хорошо влияет на скорость работы оператора. Однако это протокол использует низкоуровневую работу с COM-портом, что может не поддерживаться USB-COM переходниками. Выбирайте этот протокол если весы подключены к настоящему, аппаратному COM-порту. Так же этот протокол, вероятно, единственный, который можно использовать в весах, у которых нет цифровой клавиатуры (см. ниже — без нее весы просто невозможно переключить на другой протокол);
* ОКА — во многих моделях весов не поддерживает передачу нестабильного веса, так что работать с ним — медленнее, чем возможно. Но этот протокол поддерживают все весы «МЕРА» с цифровой клавиатурой;
* MERA-AUTO — наиболее продвинутый, рекомендованный производителем протокол. Позволяет передавать нестабильный вес. Однако весы нужно на него переключать (см. ниже), также он поддерживается не всеми весами;
* Сетевые — для весов, подключающихся не к COM-порту, а непосредственно к локальной сети.

Выбор протокола в весах: воспользуйтесь выдержкой из их [http://courierexe.ru/download/scale/mera/MERA-VTP_VT-1A_2007.pdf руководства пользователя] или [http://courierexe.ru/download/scale/mera/servmanpvm2007.pdf другой версии руководства]:

9.1 Выбор протокола
9.1.1 Удерживая нажатой кнопку «5» клавиатуры терминала, кратковременным нажатием кнопки «[[Файл:PowerOn.png]]» включить весы.
Используя ту же клавиатуру набрать код 39654 и затем нажать клавишу ввода «[[Файл:Enter.png]]» или «T» (Тара).
При правильно выполненном действии будет активизирован режим настройки и на дисплее появится сообщение «_____9».
9.1.2 Последовательно нажать кнопки «1» и «4» и ввести кодовый номер требуемого протокола '' '''(для протокола "9байт" - «0», "ОКА" - «1», "MERA-AUTO" - «5»)''' '' из таблицы кодов нажатием одной из кнопок «0»…«9».
9.1.3 Нажатием кнопки «9» зафиксировать результат.

'''Обратите внимание''' на то, что в этой инструкции подразумевается наличие полной цифровой клавиатуры с кнопками «0».."9". Если у ваших весов такой клавиатуры нет — они не поддерживают изменение протокола, и переключить их не удастся.

В программе нажмите «Настройка» — «Параметры» — «Оборудование». Поставьте галку «Использовать весы», выберите протокол и порт весов. После настройки обязательно перезагрузите программу и весы.

Для проверки работоспособности подключения можно использовать официальную [http://courierexe.ru/download/scale/mera/Oka.exe программу МЕРА]. Обратите внимание, что эта программа не будет работать, если открыта программа MeaSoft с включенным использованием весов, и наоборот. В один момент времени к весам может подключаться только одна программа.

=== Настройка весов НЕВА ===
По нашему опыту работы с весами «НЕВА» складывается интересная ситуация: производитель заявляет, что все модели их весов работают по разным протоколам. Протокол зависит от модели «пульта» — такой штуки, с индикатором и кнопками. При этом по конкретной модели пульта они передали протокол, который не соответствует действительности. В итоге конкретные весы, имевшиеся в наличии, к программе подключены (методом [https://ru.wikipedia.org/wiki/Обратная_разработка обратного инжиниринга] протокола), в списке видов весов в настройке оборудования они присутствуют, но мы не можем дать никаких гарантий того, что конкретные весы, приобретенные вами, будут работать с программой. Мы не рекомендуем этот тип весов к приобретению, но если они у вас уже есть и система с ними не работает — звоните, будем думать, что с этим можно сделать.

=== Настройка весов МАССА-К ===
Для поддержки весов Масса-К в системе предусмотрена поддержка «Протокола № 2». Этот протокол по умолчанию включен в весовых терминалах [http://courierexe.ru/download/scale/massa/TB_A_r6.2_2017.pdf А/ТВ] и [http://courierexe.ru/download/scale/massa/TB_T_r3.2_2016.pdf Т/ТВ]

=== Настройка порядка цены деления для весов ===
В случае ошибочного определения веса (когда порядок величины в несколько раз меньше или больше реального веса) в программе предусмотрена возможность коррекции значения.
Данная возможность добавлена в новых версиях программы (начиная с 596) в связи с тем, что в протоколе ОКА вес может передаваться как в граммах, так и в десятках грамм в зависимости от предела измерения весов.

Настройка порядка цены деления весов осуществляется через главное меню программы '''«Настройка»-«Параметры»'''-закладку '''«Оборудование»''' поле '''«Порядок цены деления»'''. Доступные значения поля '''«Порядок цены деления»''':

'''0''' — 1 грамм;

'''1''' — 10 грамм;

'''2''' — 100 грамм.

Таким образом, если весы показывают в 10 раз меньше, чем на самом деле, необходимо установить '''«Порядок цены деления»''' равным одному.

=== Настройка измерительного прибора ExpressCube ===
Оборудование должно работать при простом подключении (как описано в разделе «Общие сведения»).

=== Настройка измерительного прибора InSize ===

== Настройка фискальных регистраторов ==
Все фискальные регистраторы должны вноситься в справочник '''[[Фирмы]]'''. Для корректной работы ФР необходимо регистрировать ее в налоговой с нужным признаком агента, а потом прописывать его в системе.

=== Стационарные Штрих-М ===

=== Облачные LIFE PAY ===

=== Облачные Webkassa ===

== Мобильные устройства курьеров ==
Процесс выбора оборудования, установки и настройки приложения для мобильного устройства курьера подробно рассмотрен в статьях «[[Мобильное приложение курьера для Android]]» и «[[Мобильное приложение курьера для IPhone]]».

API

2021-10-25T16:16:37Z

Johny: /* Расчет стоимости доставки */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentation|HERE!]]'''
</div>

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

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

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

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

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==

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

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше.
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|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_ос3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSales|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/wordpress.zip Скачать]
|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

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

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

[[Файл:extra1.png|750px]]

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

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

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.

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

== Оформление заказа ==
=== Пример оформления заказа ===

<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<items>
<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="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

*'''neworder''' - Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

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

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

*'''sender''' - Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

*'''receiver''' - Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

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

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

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

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

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

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

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

*'''costcode''' - Кост-код сотрудника.

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

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

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

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

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

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</div>
<br />

=== Примеры ответов ===

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickup>NO</pickup>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<costcode>cc12345</costcode>
<receipt 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</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrival>2016-05-02 23:21</arrival>
<outstrbarcode>EXT123456</outstrbarcode>
<return_message>Доставлено в целости</return_message>
<department>Отдел</department>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</statusreq>
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

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

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

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

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

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

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

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

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

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

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
<streamid>1234</streamid>
</statusreq>
</source>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<streamid>1234</streamid>
</commitlaststatus>
</source>

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

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

В случае успеха Вы получите ответ
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

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

== Трекинг заказа по номеру ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
</order>
</tracking>
</source>

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
}
]
}</pre>

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

== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* вместо корневого тэга '''neworder''' указывается '''editorder'''
* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.

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

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

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

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

== Добавление вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" size="35654">JVBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg" size="74861">VBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==

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

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

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<items>
<item code="34533" quantity="1" reason="0" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</image>
</order>
</setorderinfo>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==

'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
</waybill>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

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

== Справочник регионов ==

'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>RU</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<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>
</city>
</regionlist>
</source>

== Справочник улиц ==

'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

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

*'''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>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==

'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<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>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

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

== Движение номенклатуры ==

'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</itemmovements>
</itemlist>
</source>

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

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

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

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

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

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

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

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

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Уфа город",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</source>

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

== Номенклатура приходной накладной ==

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

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

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

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

== Справочник филиалов ==

'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

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

== Справочник пунктов самовывоза ==

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

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<city>Свердловская область</city>
<town regioncode="66" country="RU">Нижний Тагил</town>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

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

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

*'''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="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==

'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<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.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==

'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==

'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
<visible>NO</visible>
</advprices>
</source>

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

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

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

== Расчет стоимости доставки ==

'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</calculator>
</source>

Параметры:
Структура данных и заполнение полей аналогичны и совместимы с [[#Оформление заказа]].

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

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

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

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1113</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<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''' - минимальная дата доставки в учетом выходных дней.
*'''deliveryprice''' - Данные по составляющим ценам доставки

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

== Получение информации о клиенте ==

'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="login" pass="pass" />
</client>
</source>

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

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<code>1082</code>
</client>
</source>

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
<auth extra="8" login="login" pass="pass" />
<datefrom>2016-02-10</datefrom>
<dateto>2016-03-10</dateto>
</smalist>
</source>

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

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
<sma>
<code>6278</code>
<number>3992</number>
<actdate>2016-02-12</actdate>
<datepay></datepay>
<dateto>2016-02-12</dateto>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<pricecorr>113.00</pricecorr>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
<signedcopyreceived>NO</signedcopyreceived>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

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

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
<specialsma>
<code>42494</code>
<ordercode>14424</ordercode>
<orderno>11111</orderno>
<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>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.

== Генерация коротких ссылок ==

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

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

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

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

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

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

Честный ЗНАК

2021-10-14T10:21:41Z

Johny: /* Формат кода Честного Знака */

С 2019 года началось внедрение единой национальной системы маркировки «Честный ЗНАК». В настоящее время маркировка специальным кодом [https://mertech.ru/blog/vse-o-skanerah-shtrih-koda/datamatrix-kod-markirovki Data Matrix] обязательна для табачной продукции, шуб, обуви, и других групп товаров. Полный список товаров, подлежащих маркировке, можно посмотреть [https://xn--80ajghhoc2aj1c8b.xn--p1ai/business здесь].

Каждая единица товара должна быть зарегистрирована производителем или реализатором в России в системе маркировки «Честный ЗНАК» и промаркирована полученным кодом.

Коды Data Matrix учитываются при всех операциях с товарами и передаются в ОФД при фискализации чеков.

= Формат кода Честного Знака =
Есть некоторые документа, которые мы используем при получении информации о форматах кодов:
[https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf Честный Знак], [https://www.atol.ru/blog/struktura-koda-markirovki/ Атол], [https://docs.google.com/document/d/1ec2ufRcd716ewjKVJTyxAv4e4sEh6jRWsqwQhr2FWQo/edit# Штрих-М], однако, к сожалению, все изначально не полные, да еще и быстро устаревают. Здесь мы постараемся описать то, что сами знаем о кодах маркировки на текущий момент.

Живой код состоит из следующих частей:
{| class="wikitable"
|-
! Пример !! Длина !! Номер байта начала !! Описание
|-
| 01 || 2 || 1 || Разделитель, всегда 01
|-
| 02900002317701 || 14 || 3 || Код, присвоенный товару. Комбинация из 14 цифр.
|-
| 21 || 2 || 17 || Разделитель, всегда 21
|-
| k3LInNbH_oG0Q || 13 || 19 || Уникальный серийный номер товара. Комбинация латинских букв и цифр. Присваивается оператором информационной системы маркировки или одним из участников оборота
|-
| || 1 || 32 || непечатаемый ASCII-символ с кодом 29
|-
| 91 || 2 || 33 || Разделитель, пока встречались значения 91 и 93
|-
| EE06 || 4 || 35 || Проверочный ключ. Генерируется оператором системы маркировки
|-
| || 1 || 39 || непечатаемый ASCII-символ с кодом 29
|-
| 92 || 2 || 40 || Разделитель, пока встречались только 92
|-
| YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= || 44 или 88 || 42 || Проверочный код (криптохвост). Комбинация из 88 (для обуви) или 44 (для текстиля и автошин) символов - букв, цифр, специальных знаков. Заканчивается (всегда?) знаком равно
|}

Обратите внимание:
* Система Measoft игнорирует - не принимает и не хранит символы с кодом 29. Они у нас просто подразумеваются по номерам позиций, где должны быть. При передаче кодов к нам эти символы нужно убирать.
* Значения разделителей (01, 21, 91, 92, 93 и др) могут встречаться и внутри полей данных. Нельзя считать, что если встретилось 91 - значит после него проверочный ключ.
* При использовании ККМ с ФФД 1.2 необходимо иметь полный код маркировки для возможности фискализации. До 1.2 - криптохвост не обязателен.

= Как передавать коды в MeaSoft =

Формат кода можно посмотреть в [https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf рекомендациях Честного ЗНАКА].

В коде Data Matrix используется специальный управляющий символ непечатаемый ASCII-символ с кодом 29. В MeaSoft необходимо передать значения БЕЗ этих символов.

Код может быть как полным, так и сокращенным до первых 31 символа.

Коды можно передавать следующими способами:
* по [[API]] в теге <code>governmentCode</code>.
* в Личном кабинете при оформлении [[Личный кабинет клиента#Добавление товара|заказа вручную]] или при [[Личный кабинет клиента#Загрузка реестра Excel|загрузке реестра Microsoft Excel]];
* в карточке корреспонденции в товарных вложениях;
* [[Импорт баз данных|импорт]] файла Microsoft Excel в MeaSoft.
Если код неизвестен, укажите знак вопроса «?». Курьер должен будет отсканировать QR-коды при вручении товара для учета в фискальном документе.

= Работа с маркированными товарами =

Работа с маркированными товарами ведется как в рамках складского учета, так и без него.

Для сканирования кодов Data Matrix требуется 2D-сканер. Его может заменить наше приложение для смартфона на ОС Android [[Мобильное приложение кладовщика для Android|'''Кладовщик''']].

=== Товары со складским учетом ===

Для указания наличия маркировки у товара в карточке справочника [[Модуль складского учета#Карточка номенклатуры|'''Номенклатура''']] используется флажок '''Есть QR-код'''. Если флажок установлен:
* в одной строке товарных вложений может передаваться только одна единица товара;
* в товарных вложениях поле '''Код товарной номенклатуры''' автоматически заполняется значением «?», если не указано значение кода.

Чтобы вести учет движения товаров по коду маркировки, в карточке справочника '''Номенклатура''' установите флажок '''Учет серийных номеров'''. В этом случае любая операция движения товара, начиная с приема на склад, сопровождается сканированием кода маркировки.

=== Товары без складского учета ===

При передаче заказа в MeaSoft продавец может указать значение кода маркировки или знак «?». При вручении заказа мобильное приложение для курьера контролирует выдачу товаров и не позволяет закрыть заказ, если не отсканирован нужный код.

= Доставка маркированных товаров =

Значения кодов передаются в мобильное приложение курьера.

Мобильное приложение контролирует движение маркированных товаров следующим образом:
* если код маркировки передан, при полной доставке код сканировать не надо, при возврате требуется отсканировать код возвращаемой позиции;
* если указан знак «?», то требуется сканировать код как при полной доставке, так и при частичной;
* при закрытии заказа недоставленным сканировать не требуется.

Мобильное приложение распознает отсканированный код как Data Matrix при одновременном выполнении условий:
# Длина кода более 30 символов.
# В строке есть сочетание «001D».

Значение отсканированного курьером кода передается в MeaSoft.

= Вывод проданных товаров из оборота =

Участник оборота маркированных товаров обязан передавать информацию о выбытии таких товаров из оборота в систему маркировки «Честный ЗНАК».

C 6 августа 2021 года вступил в силу новый формат фискальных документов версии 1.2. Он автоматизирует передачу данных в «Честный ЗНАК»: касса после формирования чека отправляет уведомление о выбытии маркированного товара из оборота. В ответ приходит подтверждение выбытия или сообщение об ошибке, касса его распечатывает.

Формат обязателен для компаний, который торгуют маркированной продукцией и дополняет действующие ФФД 1.05 и 1.1. Подробнее о том, как перейти на ФФД 1.2, см. [https://www.garant.ru/ia/opinion/author/rusinova/1475197/ по ссылке].


Чтобы просмотреть используемые в заказах коды, в [[Личный кабинет клиента#Отслеживание исходящих заказов|Личном кабинете]] в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Коды «Честный ЗНАК»'''.

Чтобы получить список проданных маркированных товаров, в личном кабинете в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Вывод из оборота «Честный ЗНАК»'''. На основании данных кассовых чеков сформируется файл в формате XML.

<spoiler text="См. также">
[https://честныйзнак.рф/barcode/?category=3 Проверка сканера на сайте «Честный ЗНАК»]<br>
[[Модуль складского учета#Карточка номенклатуры|Карточка номенклатуры]]<br>
[[Мобильное приложение курьера для Android]]<br>
[[Мобильное приложение кладовщика для Android]]
</spoiler>

Честный ЗНАК

2021-10-14T10:17:04Z

Johny:

С 2019 года началось внедрение единой национальной системы маркировки «Честный ЗНАК». В настоящее время маркировка специальным кодом [https://mertech.ru/blog/vse-o-skanerah-shtrih-koda/datamatrix-kod-markirovki Data Matrix] обязательна для табачной продукции, шуб, обуви, и других групп товаров. Полный список товаров, подлежащих маркировке, можно посмотреть [https://xn--80ajghhoc2aj1c8b.xn--p1ai/business здесь].

Каждая единица товара должна быть зарегистрирована производителем или реализатором в России в системе маркировки «Честный ЗНАК» и промаркирована полученным кодом.

Коды Data Matrix учитываются при всех операциях с товарами и передаются в ОФД при фискализации чеков.

= Формат кода Честного Знака =
Есть некоторые документа, которые мы используем при получении информации о форматах кодов:
[https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf Честный Знак], [https://www.atol.ru/blog/struktura-koda-markirovki/ Атол], [https://docs.google.com/document/d/1ec2ufRcd716ewjKVJTyxAv4e4sEh6jRWsqwQhr2FWQo/edit# Штрих-М], однако, к сожалению, все изначально не полные, да еще и быстро устаревают. Здесь мы постараемся описать то, что сами знаем о кодах маркировки на текущий момент.

Живой код состоит из следующих частей:
{| class="wikitable"
|-
! Пример !! Длина !! Описание
|-
| 01 || 2 || Разделитель, всегда 01
|-
| 02900002317701 || 14 || Код, присвоенный товару. Комбинация из 14 цифр.
|-
| 21 || 2 || Разделитель, всегда 21
|-
| k3LInNbH_oG0Q || 13 || Уникальный серийный номер товара. Комбинация латинских букв и цифр. Присваивается оператором информационной системы маркировки или одним из участников оборота
|-
| || 1 || непечатаемый ASCII-символ с кодом 29
|-
| 91 || 2 || Разделитель, пока встречались значения 91 и 93
|-
| EE06 || 4 || Проверочный ключ. Генерируется оператором системы маркировки
|-
| || 1 || непечатаемый ASCII-символ с кодом 29
|-
| 92 || 2 || Разделитель, пока встречались только 92
|-
| YXiyKfiHjE4YE8b+YVMC1O5r8VtpplA3AwcCqrcG9Dk= || 44 или 88 || Проверочный код (криптохвост). Комбинация из 88 (для обуви) или 44 (для текстиля и автошин) символов - букв, цифр, специальных знаков. Заканчивается (всегда?) знаком равно
|}

Обратите внимание:
* Система Measoft игнорирует - не принимает и не хранит символы с кодом 29. Они у нас просто подразумеваются по номерам позиций, где должны быть. При передаче кодов к нам эти символы нужно убирать.
* Значения разделителей (01, 21, 91, 92, 93 и др) могут встречаться и внутри полей данных. Нельзя считать, что если встретилось 91 - значит после него проверочный ключ.
* При использовании ККМ с ФФД 1.2 необходимо иметь полный код маркировки для возможности фискализации. До 1.2 - криптохвост не обязателен.

= Как передавать коды в MeaSoft =

Формат кода можно посмотреть в [https://честныйзнак.рф/upload/iblock/a6a/Rekomendatsii_dlya_uchastnikov_osushchestvlyayushchikh_realizatsiyu_v_roznitsu.pdf рекомендациях Честного ЗНАКА].

В коде Data Matrix используется специальный управляющий символ непечатаемый ASCII-символ с кодом 29. В MeaSoft необходимо передать значения БЕЗ этих символов.

Код может быть как полным, так и сокращенным до первых 31 символа.

Коды можно передавать следующими способами:
* по [[API]] в теге <code>governmentCode</code>.
* в Личном кабинете при оформлении [[Личный кабинет клиента#Добавление товара|заказа вручную]] или при [[Личный кабинет клиента#Загрузка реестра Excel|загрузке реестра Microsoft Excel]];
* в карточке корреспонденции в товарных вложениях;
* [[Импорт баз данных|импорт]] файла Microsoft Excel в MeaSoft.
Если код неизвестен, укажите знак вопроса «?». Курьер должен будет отсканировать QR-коды при вручении товара для учета в фискальном документе.

= Работа с маркированными товарами =

Работа с маркированными товарами ведется как в рамках складского учета, так и без него.

Для сканирования кодов Data Matrix требуется 2D-сканер. Его может заменить наше приложение для смартфона на ОС Android [[Мобильное приложение кладовщика для Android|'''Кладовщик''']].

=== Товары со складским учетом ===

Для указания наличия маркировки у товара в карточке справочника [[Модуль складского учета#Карточка номенклатуры|'''Номенклатура''']] используется флажок '''Есть QR-код'''. Если флажок установлен:
* в одной строке товарных вложений может передаваться только одна единица товара;
* в товарных вложениях поле '''Код товарной номенклатуры''' автоматически заполняется значением «?», если не указано значение кода.

Чтобы вести учет движения товаров по коду маркировки, в карточке справочника '''Номенклатура''' установите флажок '''Учет серийных номеров'''. В этом случае любая операция движения товара, начиная с приема на склад, сопровождается сканированием кода маркировки.

=== Товары без складского учета ===

При передаче заказа в MeaSoft продавец может указать значение кода маркировки или знак «?». При вручении заказа мобильное приложение для курьера контролирует выдачу товаров и не позволяет закрыть заказ, если не отсканирован нужный код.

= Доставка маркированных товаров =

Значения кодов передаются в мобильное приложение курьера.

Мобильное приложение контролирует движение маркированных товаров следующим образом:
* если код маркировки передан, при полной доставке код сканировать не надо, при возврате требуется отсканировать код возвращаемой позиции;
* если указан знак «?», то требуется сканировать код как при полной доставке, так и при частичной;
* при закрытии заказа недоставленным сканировать не требуется.

Мобильное приложение распознает отсканированный код как Data Matrix при одновременном выполнении условий:
# Длина кода более 30 символов.
# В строке есть сочетание «001D».

Значение отсканированного курьером кода передается в MeaSoft.

= Вывод проданных товаров из оборота =

Участник оборота маркированных товаров обязан передавать информацию о выбытии таких товаров из оборота в систему маркировки «Честный ЗНАК».

C 6 августа 2021 года вступил в силу новый формат фискальных документов версии 1.2. Он автоматизирует передачу данных в «Честный ЗНАК»: касса после формирования чека отправляет уведомление о выбытии маркированного товара из оборота. В ответ приходит подтверждение выбытия или сообщение об ошибке, касса его распечатывает.

Формат обязателен для компаний, который торгуют маркированной продукцией и дополняет действующие ФФД 1.05 и 1.1. Подробнее о том, как перейти на ФФД 1.2, см. [https://www.garant.ru/ia/opinion/author/rusinova/1475197/ по ссылке].


Чтобы просмотреть используемые в заказах коды, в [[Личный кабинет клиента#Отслеживание исходящих заказов|Личном кабинете]] в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Коды «Честный ЗНАК»'''.

Чтобы получить список проданных маркированных товаров, в личном кабинете в пункте основного меню '''Отслеживание''' создайте выборку заказов и нажмите на кнопку '''Экспорт в Excel''' > '''Вывод из оборота «Честный ЗНАК»'''. На основании данных кассовых чеков сформируется файл в формате XML.

<spoiler text="См. также">
[https://честныйзнак.рф/barcode/?category=3 Проверка сканера на сайте «Честный ЗНАК»]<br>
[[Модуль складского учета#Карточка номенклатуры|Карточка номенклатуры]]<br>
[[Мобильное приложение курьера для Android]]<br>
[[Мобильное приложение кладовщика для Android]]
</spoiler>

Как с нами работать

2021-10-13T13:04:57Z

Johny: /* О системе */

Уважаемый (потенциальный?) пользователь системы "Курьерская служба 2008"!

В этой статье я опишу теорию и практику взаимодействия с нашей компанией, отвечу на часто задаваемые вопросы касающиеся этого взаимодействия. Я постараюсь максимально открыто описать нашу кухню.
Обладая этой информацией Вам будет гораздо быстрее и проще решать свои задачи по автоматизации.

<div style="text-align: right;">''Руководитель MeaSoft<br>'''Евгений Милевский'''''</div>

==О системе==
На сегодняшний день система «Курьерская служба» отметила своё четырнадцатилетние. За это время её положительно оценили и активно с нами сотрудничают более 300 компаний. Наши партнёры находятся в разных странах: Россия, Казахстан, Узбекистан, Таджикистан, Украина, Белоруссия, Киргизия, Латвия. С помощью нашего сервиса ежедневно 4,5 тысячи курьеров доставляют 60 тысяч отправлений от 11 тысяч клиентов.
Сама созданная нами «Курьерская служба» состоит из 200 связанных друг с другом таблиц, в некоторых из которых встречается по 50 миллионов записей. Мы постоянно работаем над её совершенствованием, чтобы наши клиенты всегда были впереди конкурентов.

===Бизнес-модель===
Наших клиентов, как существующих, так и потенциальных (а еще больше, конечно, меня самого!) часто интересует вопрос успешности и финансовой стабильности нашей компании. Это естественно, т.к. в случае ухода компании с рынка покупатели системы лишаются поддержки и прочих сервисов, без которых система утрачивает возможность адаптироваться под меняющиеся условия рынка. С такой "мертвой" системы компании придется куда-то переходить в максимально сжатые сроки. Поэтому здесь я расскажу, как мы зарабатываем.

Я делю рынок курьерских компаний на 3 части:
*'''Мелкие компании''' - стартапы и прочее, со штатом до 10 курьеров. Такие компании не очень интересно автоматизировать - выигрыш производительности труда от ведения базы данных, штрих-кодирования, расчета зарплаты и т.д. - минимальный, если вообще есть. Такие компании неплохо (если такое слово вообще применимо к подобным компаниям) себя чувствуют и в экселе, а учет отправлений сводится к фразе "ну я тебе давал отправление, ты его доставил?". Понятно, что для вменяемой автоматизации у такой компании нет ни денег ни потребности. Мы на такие компании никогда не нацеливались, и в свое время у нас получался неплохой симбиоз с системами вроде "Аурамы", которая позволяла подобной компании начать работать "в один клик" за 3 копейки. Это позволяло компании слегка подрасти, и при приближении к 10 сотрудникам их система переставала справляться, они переходили в следующую категорию и приходили к нам. "Конкуренты" "выращивали" нам клиентов! В последнее время ситуация изменилась: подобные системы стали дороже нашей, и клиенты из данной категории стали к нам приходить сразу. Надо, может, приподнять цены уже наконец? Подумаю.
*'''Средние компании''' - со штатом курьеров от 10 до 200 курьеров. Это наша ниша рынка. Самая распространенная, созревшая к автоматизации. Здесь можно добиться действительно большого роста эффективности труда. В тоже время, как правило, компаниям из этой категории хватает функциональности нашей системы "из коробки", процесс внедрения прост и надежен. Хотелки по доработкам если и возникают, то уже в процессе работы, а не на старте, что сильно упрощает их реализацию.
*'''Крупные компании''' - более 200 курьеров. Данная ниша гораздо меньше предыдущих, компании как правило уже чем-то автоматизированы, что создает много проблем при внедрении: в "их" системе что-то было реализовано по-другому, пользователям всегда не удобно переучиваться, они устраивают саботаж. Бизнес-процессы уже отлажены, и встроиться в них, повторить, нужно практически без репетиции. Нужно вести длительные переговоры, совещания, анализировать бизнес-процессы, составлять ТЗ на доработки для тех участков, которые у них уже были как-то реализованы, дорабатывать без тестирования на продакшене, как мы любим. В общем, очень много непродуктивной деятельности. В проекте внедрения занято куча народа, всякого рода <rspoiler text="руководители направлений">Риторический вопрос: Сколько руководителей нужно привлечь к проекту, чтобы его провалить?</rspoiler> и даже "менеджеры самого среднего звена". Вероятность успеха проекта внедрения граничит с авантюрой. Такие клиенты у нас тоже есть, в основном выросшие из 2-й категории. Не бросать же людей из-за того, что они выросли! Мы в ответе за тех, кого приручили ©.

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

Итак, наши клиенты из второй группы, со средним чеком в районе 20 т.р. в месяц, но их [http://courierexe.ru/our_clients.htm достаточно]. У нас нет <rspoiler text="якорного">Какое правильное слово кто-то придумал для обозначения того, что тянет вниз, не дает двигаться куда нужно!</rspoiler> клиента: поступления от самого крупного клиента не превышают 5% всего бюджета. Это позволяет мне быть действительно не предвзятым и уверенным в надежности выстроенной структуры. Так же, очень важный момент: это позволяет мне не играть в политику, балансируя между "хочу" отдельных клиентов и правильностью разработки с точки зрения системы, а ставить во главу угла именно архитектуру, гибкость, масштабируемость и поддерживаемость системы.

Бюджет, в основном, складывается из регулярных платежей наших клиентов: за аренду и поддержку. Продажа системы, равно как и платная доработка, в финансовом отношении мало эффективна, т.к. это разовые вещи, на которых построить надежный прогнозируемый бюджет невозможно. Подобные разовые платежи в сумме обеспечивают нам 10-15% бюджета, что, согласитесь, пренебрежимо мало. Поэтому мы ориентируемся на долгосрочное взаимовыгодное сотрудничество со всеми нашими клиентами. Мы заинтересованы в росте бизнеса всех наших клиентов, и способствуем этому всеми доступными нам способами.

===Эффективность===
Моя главная задача - эффективность использования всех ресурсов для получения максимальной отдачи для бизнеса наших клиентов на каждый потраченный рубль. Для этого я применяю все возможные подходы. У каждого из этих методов есть свои плюсы и минусы, поэтому я постараюсь их все здесь описать, чтобы Вы понимали, откуда берутся некоторые минусы в работе с нами, и что Вы получаете взамен.
====Команда====
Для эффективной работы команда должна быть компактной. Оптимальный размер команды для разработки ПО - 7-15 человек. Это тот объем, который позволяет руководителю дотянуться до каждого сотрудника, проконтролировать работу, объединить усилия всех сотрудников в единый организм и комплексно, целенаправленно решать стратегические задачи. Понятно, что написать Windows с такой командой невозможно, ее нужно сильно расширять. Однако это требует существенного расширения сопутствующего персонала. К сожалению, речь идет не только о найме проект-менеджера на каждую группу по 7 человек (зарплаты которых измеряются сотнями тысяч рублей), но и раздутии штата прочими сотрудниками, напрямую в процессе разработки/сопровождения не занятыми, поскольку работу групп нужно координировать, большую задачу нужно разбить на блоки, требования, функциональность, методы тестирования, интерфейсы взаимодействия которых нужно полностью задокументировать. Объем технической документации при "правильном" подходе занимает больше времени и стоит дороже, чем сам процесс разработки. После разработки каждого куска его надо тестировать отдельными штатными единицами, а потом пытаться склеить эти блоки вместе. В случае же с компактной командой ее можно просто собрать вместе, и сказать: "Давайте сделаем вот это. Ты делаешь это, а ты - вон то, через 2 дня собираемся вместе и проверяем". Поэтому я стараюсь удержать размер команды в оптимальном диапазоне. Пусть мы не можем такими силами взяться за какие-то глобальные мегапроекты, зато предельно эффективно решаем конкретные текущие задачи, которые ставят перед нами наши клиенты.

Мы, конечно, разбираемся в предметной области. Я начинал свою карьеру с работы курьером еще в 2000-м году, потом в офисе курьерской службы. Коммерческий директор - обязательно с опытом руководящей работы в курьерской службе. Мы лично встречаемся, общаемся с клиентами. Остальные сотрудники обязательно начинают свою работу с изучения предметной области. Полное погружение в нее - обязательное условие нормальной работы каждого сотрудника. К сожалению, большинство разработчиков подходят к своей работе только с позиции "мы умеем писать код, нам заказчик скажет, что написать, мы сделаем". Лично сталкивался с "автоматизаторами", которые только от меня узнавали, что после распределения заказов по курьерам их нужно еще физически на складе сортировать, а не просто скинуть курьерам полученные списки. Поэтому мы прикладываем все усилия к тому, чтобы такими не быть.

====Задачи====
Для максимизации эффективности труда необходимо выполнять только самые эффективные задачи. Есть такое <rspoiler text="правило 20 и 80 процентов">20% людей выпивают 80% пива. 20% работы приносит 80% пользы.</rspoiler>. Конечно, мы не делаем только 20% работы, но делаем 90%. Как мы выбираем наиболее востребованные задачи, чтобы не работать впустую?
*Мы никогда не придумываем сами себе задачи. У нас есть много клиентов, которые "на местах" сталкиваются с живыми ситуациями, и передают нам свои пожелания. Зачем нам изобретать свой велосипед?
*К нам постоянно поступает множество "хотелок" от клиентов. Им нужно как-то выдавать приоритеты. Для этого я их делю на 2 категории. Первая категория содержит:
**То, что просят многие.
**То, без чего реально процесс у клиента не работает.
**То, что можно сделать быстро и без <rspoiler text="хвостов.">Бывает, что задача вроде быстрая и простая, но когда ее сделаешь, клиент начинает уточнять: "а нам надо не так, а сделайте вот так", и мы вязнем в переговорах, уточнениях того, что же ему на самом деле нужно, многократных переделках. А время идет и другие, серьезные задачи стоят. Такую задачу нужно поставить в очередь, запланировать на нее время чтобы все согласовать, утрясти и реализовать по четко поставленному ТЗ.</rspoiler>
**То, что входит в поддержку пользователей.
**То, за что <rspoiler text="платят.">Плата за доработку, как я буду писать ниже, не столько заработок, сколько демонстрация заинтересованности клиента в доработке. Так же, оплата работы предполагает установку конкретных сроков, которых мы должны придерживаться. Впрочем, что касается сроков, то выбирая между сделать наспех но к сроку, или завалить срок но сделать качественно я всегда выбираю второе.</rspoiler>
Вторая категория - все остальное:
**То, что просит только один клиент, и ему это не критично, он не считает это важным чтобы сделать платно.
**То, что <rspoiler text="очень объемное">Месяц работы программиста, например.</rspoiler>, а польза не очевидна.
**То, что <rspoiler text="не понятно, как делать.">Понятно, что было бы удобно, если бы программа сама доставляла отправления, или печатала на принтере зарплаты курьеров, но как это сделать мы ПОКА не знаем. Может придумаем в будущем?</rspoiler>
Естественно, сначала мы делаем задачи из первой категории, и по остаточному принципу - остальные (даже если в теме обращения написано "ОЧЕНЬ ВАЖНО!!!"). Такой подход приводит к тому, что некоторые задачи могут стоять в очереди вечно. Но их процент не очень большой, а сделать все и сразу попасть в светлое будущее, конечно, невозможно.

====Экстремальное программирование====
В своей работе в разной степени мы используем принципы [https://ru.wikipedia.org/wiki/Экстремальное_программирование экстремального программирования]. Мое самое любимое положение из него - код должен максимально быстро начинать приносить реальную пользу (прибыль!) нашим клиентам. При классическом подходе к разработке, как я уже писал, сначала пишется документация всей доработки, потом разбивается на подзадачи, реализуется, тестируется, отлаживается и т.д., на все это уходит куча времени и денег. Потом ее пытаются сдать заказчику, и тут оказывается, что задачу изначально не совсем так поняли. Чтобы этого всего избежать, мы сходу пишем небольшие куски, и сразу, даже без тестирования, отдаем заказчику. Да, при этом могут быть ошибки. Но заказчик сразу начинает пользоваться, решать свои бизнес-задачи, т.е. экономить деньги. Ошибки, замечания, пожелания, которые он обнаруживает уже в промышленной эксплуатации, а не на примере [https://ru.wikipedia.org/wiki/Научный_юмор#Сферический_конь_в_вакууме сферических коней в вакууме], как это делает тестировщик, в реальном времени передаются разработчикам и так же быстро устраняются. В результате мы получаем огромный прирост эффективности - в разы, если не на порядки. С одной стороны сильно сокращаются издержки на документирование, тестирование, случаи решения несуществующих задач, а с другой стороны - клиент получает самую свежую функциональность со скоростью горячих пирожков и сразу начинает на этом зарабатывать. Пусть эта функциональность и не обязательно полная или надежная - это лучше, чем ничего. Иногда задача даже может остаться не очень доделанной - главное, что она решает поставленную перед ней конкретную задачу на конкретных данных. Поэтому иногда бывает, что клиент пытается воспользоваться функцией, а она не работает, т.к. писалась для конкретной задачи. С точки зрения клиента это <rspoiler text="глюк">- Исправьте немедленно!!!</rspoiler>, а с нашей - это недофича, которой могло и не быть, и <rspoiler text="никто бы не узнал, что она могла быть">Если, конечно, она не заявлена в перечне функциональности системы: в этом случае мы должны обеспечить корректность ее работы в соответствии с документацией и/или здравым смыслом</rspoiler>.

====Коммуникация====
Для оперативного решения задач необходимо всегда быть в тесном контакте. В рамках поддержки мы работаем на расстоянии телефонного звонка, многие вопросы решаются в реальном времени. Для руководителей компаний на 3-м тарифе поддержки мы предоставляем еще больший сервис: они могут звонить лично мне на мобильный, и получать консультации на максимально высоком уровне. Прямо в реальном времени, находясь, например, на встрече, можно подключить нашу компанию в моем лице к диалогу!

====Бюрократия====

====Поддержка====
Поддержка системы является крайне важным элементом ее совершенствования. Когда мы видим, что с каким-то вопросом к нам обращаются регулярно - мы понимаем, что что-то там сделано не идеально, и это нужно исправлять.

====Эволюция====
Наша компания, как и наша система, растет. Примерно на 30% в год. Есть плюсы:
*Скорее всего мы не закроемся :-)
*Система становится все более функциональной, и "из коробки" позволяет решать все больше задач.
*Мы совершенствуем свои процессы, их надежность и эффективность постоянно повышаются. <spoiler text="Примеры">
*Когда-то документы оформлялись вручную, и лицензионные ключи на аренду также делались вручную. Ключ после оплаты можно было ждать неделю, старожилы помнят.
*Мы разработали и внедрили тикетную систему. Уже через несколько месяцев мы задавались вопросом "а как же мы работали до этого?". Сейчас через нее проходят все обращения, задачи. Она позволяет нам не потерять ни одного вопроса или хотелки (хотя не скрою, некоторые вопросы у нас могут висеть и очень долго, т.к. решения их пока нет. Но все-равно мы о них помним!)
*Недавно мы сделали интерактивное [https://home.courierexe.ru/whatsnew средство отслеживания изменений] в системе. Теперь в реальном времени можно смотреть, что сделали программисты, по каким тикетам, в каких блоках.</spoiler>
Но есть и минусы:
*Система становится все сложнее, и любая доработка в ней требует все больше усилий. Это общая беда больших систем: по подсчетам Microsoft программисты тратят 90% времени на поиск места в коде их ERP-систем, куда нужно внести изменение, и только 10% - на написание этих изменений.
*Уменьшается объем личного присутствия. Несколько назад я лично приезжал к каждому клиенту в Москве, с ноутбуком, и что-то для них дописывал. Но это и хорошо: компания гораздо лучше работает, когда она выстроена как система, а не ручное управление одним человеком.

==Отказ от ответственности==
==Что входит в покупку (аренду) системы==
==Что входит в поддержку==
===Тариф 1===

Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.

===Тариф 2===

* Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.
* Регулярное обновление программы до последней версии — 1 раз в месяц.
* Настройка системы под бизнес-процессы клиента в рамках возможностей, доступных без перекомпиляции программы и ее модулей (за исключением настройки модуля интеграции с внешними системами для импорта/экспорта данных во внешние системы) — не более 5-ти рабочих часов разработчика в месяц. В большинстве случаев это создание дополнительных отчетов и печатных форм, настройка автоматизации.

===Тариф 3===

* Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.
* Регулярное обновление программы до последней версии — 1 раз в месяц.
* Настройка системы, доработка функциональности, в том числе с перекомпиляцией программы и/или ее модулей — не более 15-ти рабочих часов разработчика в месяц.
* 1 плановый выезд специалиста в месяц (в пределах г. Москвы).

==Оплата счетов==

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

Мы знаем, что бывают форс-мажоры и долгая обработка платежа банком. Поэтому система продолжает работать до 7 числа следующего месяца и при каждом запуске напоминает о неоплаченном счете.

Мы добились минимальной стоимости системы за счет автоматизации многих процессов — в том числе и автоматизация рассылки ключей. Ключи рассылаются только после зачисления средств на наш расчетный счет.

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

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

*'''Обратиться "по адресу"''' Обратиться в поддержку можно по будням '''(а теперь и в выходные с 10 до 18!)''' (в соответствии с трудовым календарем Российской Федерации) с 8:00 до 21:00 по московскому времени любым удобным для Вас способом: Почта [mailto:support@courierexe.ru support@courierexe.ru], Телефон +7 (495) 987-17-12, бесплатный по России 8 (800) 707-90-35 или skype: courierexe, courierexe1, courierexe2, courierexe3.

*'''Представиться''' При обращении любым из способов Вам понадобится представиться: назвать ФИО и компанию, в которой Вы работаете. Возможно, продиктовать телефон и адрес электронной почты для обратной связи. В случае отсутствия данной информации (особенно по почте) специалисты технической поддержки, прежде чем начать решать проблему, сначала будут выяснять эту информацию, на что уходит драгоценное время. Мы не принимаем анонимки ни в каком виде! Особенно частая ошибка - когда пользователи пишут с общей почты организации, вида "info@courier.ru" и в подписи, вместо контакта человека написано что-то вроде "С уважением, команда курьерской службы". Нужна конкретная заявка от конкретного человека: мы должны знать, с чем работаем.

*'''Предоставить полную информацию''' Очень важно предоставить исчерпывающую информацию о своем вопросе. Номер заказа, с которым возникла проблема, или название клиента, если проблема с клиентом. Обратите внимание: если проблема касается сразу группы заказов – это хорошо, что Вы например, заметили "Во всех позавчерашних заказах происходит ...", и это даже может нам помочь, но номер конкретного заказа, хотя бы одного из той группы, нужно назвать. Сотрудник технической службы должен увидеть проблему, иначе может случиться так, что, просмотрев несколько заказов и не увидев никаких ошибок, он сочтёт, что дело в «человеческом факторе» и закроет тикет. Это абсолютно нормально и логично: люди ошибаются намного чаще машин! Если вопрос по отчету – укажите точную последовательность действий для его получения, какие пункты меню выбирали, какие данные вводили, приложите сам отчет. Если загружаете файлы – обязательно приложите исходные файлы и опишите, как загружаете. Будьте точны в формулировках! Неправильно сформулированное описание проблемы может привести к тому, что наш специалист будет искать возникшую проблему совсем не там, где она находится, и потеряет Ваше и наше время. Например, после получения формулировки "В подключении дата стоит не такая" последует вопрос о том, что же такое, в Вашем представлении "подключение", и эту потерю времени можно предотвратить, указав понятные нашим сотрудникам термины, а еще лучше – приложить скрин-шот, на котором было бы сразу видно, и какую именно Вы имеете в виду дату.

*'''Убедиться в создании задачи''' При любом обращении сотрудник технической поддержки должен создать так называемый "тикет" - это номер обращения по одному конкретному вопросу, в рамках которого решается Ваша задача. Тикет - это крайне удобное средство контроля за выполнением задач, он гарантирует, что ни один вопрос не потеряется бесследно. О создании тикета Вам на электронную почту придет письмо. Так же, Вы можете просматривать свои тикеты в [https://home.courierexe.ru личном кабинете], и контролировать - что делается, а на что от Вас ожидают реакции.

Условия, описанные выше, нормальны и понятны любому здравомыслящему человеку, но часто из-за волнения, собственных проблем клиентов и по другим причинам мы получаем заявки без необходимых нам для выполнения поставленных задач сведений. Вместо быстрого и эффективного решения вопроса начинается длинная переписка с выяснением, кто и откуда прислал претензию и что же его, собственно, не устраивает.

'''Важно! Такие задачи, как наименее продуктивные, получают низший приоритет, поэтому потратьте пять минут и сформулируйте всё в деловом ключе: чётко, полно, объективно.'''

'''UPDATE''' В последнее время получил несколько вопросов о программе по Whatsapp'y на личный мобильный телефон с неизвестных номеров. Такие обращения сразу отмечаются как спам, и номера банятся. '''''Коллеги! Ну давайте уже уважать друг друга!'''''

===Контроль качества===
Если Вы не удовлетворены качеством решения Вашего вопроса, есть несколько способов повлиять на ситуацию:
*'''Проголосовать по телефону''' После окончания телефонного разговора с нашими специалистами, система предлагает поставить им оценку.
*'''Проголосовать из письма''' В письме об изменении тикета по Вашему обращению Вам предлагают выбрать оценку.
*'''Обратиться к директору''' По почте [mailto:admin@courierexe.ru admin@courierexe.ru] или, в экстренных ситуациях, даже телефону: +7 (916) 114-79-92. При обращении нужно представиться, назвать номер тикета и/или максимально точное время телефонного общения с нашими сотрудниками - я лично подниму историю вопроса, записи телефонных разговоров, дам оценку ситуации и обязательно приму меры! Надо понимать, что голословные, не проверяемые, претензии вроде "я звонил когда-то, не помню когда, и мне плохо ответили" я принять не могу.

===Почему не нужно обращаться к программистам или директору===

Ответ на этот вопрос очевиден: первое, что Вас спросят: какой ответ Вы получили, обратившись в службу поддержки? Не забывайте, что все мы – люди, у всех есть масса важных и нужных дел, и отрывать от них и требовать внимания к себе в обход наших внутренних корпоративных правил – не лучший способ заручиться нашей поддержкой. Вас просто направят прочитать, кому нужно звонить в случае возникновения проблем, а приоритет Вашего дела может быть понижен.

==Почему вы не сообщаете об изменениях?==
===Текущие изменения функциональности и логики работы===
Сообщаем, и постоянно! На [https://home.courierexe.ru/whatsnew специальной странице] в реальном времени публикуются все изменения. Зайдите и посмотрите на нее.

Вряд ли вы хотите ежедневно получать длинные простыни с различными изменениями и дополнениями, вносимыми в программу. Поэтому мы публикуем краткие новостные подборки специально для наших клиентов в наших группах в [https://vk.com/measoft ВК], [https://facebook.com/courierexe Facebook] и в [https://t.me/measoft Telegram-канале]. Подписывайтесь!

Любое изменение вначале анализируется на предмет того, оно отразится на работе существующих процессов наших клиентов. Мы подходим к этому с особой тщательностью. Именно поэтому нам очень важно знать, как вы используете систему, и стараться своевременно предотвратить использование ее механизмов не по назначению. Однако клиентов у нас сотни, процессов у них тысячи, а мы одни, и поэтому иногда, очень редко, бывают и несовместимые изменения, которые мы всегда стараемся быстро исправить, если так случилось. Единственный способ это надежно предотвратить - никогда ничего не менять. Не делать никаких доработок, не обновлять систему клиентам, не добавлять новых функций, интеграций, поддержки нового оборудования и т.д. Наверное, это не совсем то, что вы ожидаете от поставщика ПО, верно?

===Добавление новых функций===
Мы постоянно добавляем новые функции, расширяющие возможности системы. Однако на работу такой функции оказывают влияние тысячи процессов, уже происходящих в системе. Поэтому мы вначале тестируем её на внутренних серверах, да и потом долгое время следим за корректностью её работы: собираем информацию об опыте использования, дописываем, улучшаем, переделываем. Поэтому, сразу после выхода новую функцию нет смысла документировать – она еще будет меняться и не раз.
В случае возникновения погрешностей – в процессе эксплуатации они выявляются и устраняются. У программистов есть такая поговорка "Каждая последняя ошибка, найденная в программе, на самом деле является предпоследней". Т.о. мы никогда не можем сказать, какой-то процесс идеален. Он может быть таковым до очередного улучшения, которое начнёт с ним конфликтовать, или возникновения ещё какой либо особой ситуации.

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

Отсюда вытекает понимание, что у новой функции нет одного момента, когда она становится продуктом, и о ней нужно всем сообщить. Есть только постепенно растущая степень нашей уверенности в этой функции. Если Вы ранее обращались к нам с вопросом о добавлении подобной функции – мы стараемся об этом помнить, и сообщить Вам о ней, но это тоже не всегда возможно. Поэтому рекомендуется периодически просматривать вики – как различные описания функций, так и страницу истории версий.

== Как доработать функциональность ==

=== Почему мы задаем вопросы ===
[[Файл:Workflowrus.jpg|thumb|450px|right|Старый баян о недопонимании при разработке, заботливо переведенный на русский для вас лично мной.]]
Полезно почитать на тему: '''[https://ru.wikipedia.org/wiki/%D0%9F%D1%8F%D1%82%D1%8C_%D0%BF%D0%BE%D1%87%D0%B5%D0%BC%D1%83 Пять почему]'''.

Как я уже писал, в день в среднем мы обрабатываем 30 обращений. Из них 2-3 звучат примерно как «А добавьте в карточку курьера галку „Выдан фирменный портфель“» (№ 1) или «А сделайте, чтобы на каждый район на карте можно было назначить отдельного курьера на каждый день недели» (№ 2). «А добавьте в отчет „количество доставок по клиентам“» поле «Среднее отношение количества выездов курьера к километражу между точками, умноженному на средний счет клиента» (№ 3).

За ~200 рабочих дней в году мы добавили бы минимум 500 таких галок, кнопок и полей, а за 10 лет — 5000. На самом деле — гораздо больше, так как они тянут друг друга.

По первому примеру: — А завтра вы, наверное, попросите добавить галку «Выдан планшет», а потом «Выдан проездной», плащ-палатка, футболка и солнечные очки? Клиент говорит «Ну, видимо, да…». Представляете, насколько система была бы не управляема сейчас? На практике, конечно, мы находим решение задач, главное — понимать, что именно он хочет. В данном случае клиенту нужно учитывать выдачу сотрудникам и прием неограниченного количества видов инвентаря. И так в модуле складского учета, в номенклатуре, появилась галка «<rspoiler text="инвентарь">Сейчас она уже преобразилась в выпадающий список „Тип номенклатуры“, поскольку наши клиенты пожелали еще вести учет расходных материалов вроде „незамерзайки“, и упаковки, которую система еще и [[Модуль складского учета#Расчет упаковки|подбирать]] под конкретные товары умеет!</rspoiler>», и клиент, помимо того, что просил, получил еще средство контроля за остатками своих фирменных портфелей на складе.

По второму пункту — понятно же, что в 95 % случаев на одном районе курьер будет работать каждый день недели, а то, что в выходные у них работает другой курьерский состав на тех же районах — это исключение. С гораздо большей вероятностью, вместо разных курьеров по дням недели, нашим клиентам понадобятся разные курьеры в зависимости от массы отправления (пешие/вело/авто курьеры), или срочности. Если бы мы добавляли возможность указания разных курьеров для всех этих вариаций (а сколько их еще можно придумать!), схемами на карте стало бы невозможно пользоваться. Понимая задачу, которую решает клиент, мы делаем возможность копирования схем. И клиент может нарисовать районы, скопировать схему, и 2 схемы назвать «будни» и «выходные», и назначить разных курьеров. А можно — сделать 7 схем по дням недели. А можно — отдельно для пеших, и отдельно — для автокурьеров.

По третьему эпизоду совсем все просто: Делается отдельный отчет в «доп. возможности», в котором выводятся те показатели, которые нужны клиенту, считающиеся по его ТЗ.

Очень частая проблема недопонимания: отчеты. Обращается клиент с просьбой добавить ему в раздел «Адреса» какое-то поле, например, количество поездок по отправлению в выдаче. На самом деле, добавление такого поля практически исключено по чисто технической причине: для вывода отправлений серверу придется для каждого из них «заглядывать» в «выдачу», и считать их количество. Для 99,999 % задач, решаемых пользователями в адресах, эти данные не нужны, но их расчет будет происходить, и замедлять работу всех систем всех наших клиентов. Но возникает и другой вопрос: «зачем вам это поле?». А клиент говорит «Мы будем выводить это поле, выгружать все 10 тыс. заказов с ним в эксель, там формулами считать наценку за лишние поездки, а потом загружать обратно этот эксель с рассчитанными ценами. Сейчас у нас круглосуточно работают 3 человека, которые в каждое отправление заходят, открывают закладку „История выдачи“, смотрят, сколько там строк, и вписывают в эксель.» Занавес! :-) Чтобы вы понимали — я не сильно утрирую, когда это пишу: люди действительно совершают ненужные подвиги каждый день. Здесь, если подходить формально, можно просто сказать «Нет, мы этот столбец не добавим». Если немного подумать — можно сделать отдельный отчет, который выведет в эксель требуемый клиентом показатель. Но если подойти к задаче действительно качественно, то в тариф клиента можно добавить услугу повторной доставки, которая сразу будет рассчитываться по тому алгоритму, который нужен клиенту, и процесс расчетов в экселе выпадет полностью, значительно упростив всем жизнь. Чем мы и занимаемся. '''Главный принцип хорошего программиста гласит «Клиенту надо дать не то, что он просит, а то, что ему действительно нужно».''' Тут вы, наверное, думаете, что пишут вам тут про каких-то дураков, а вы-то (именно вы!) действительно знаете, как правильно решать вашу проблему, и не нужно больше ничего выяснять, надо делать то, что вы говорите. Но на самом деле люди придумывают такие неконструктивные подходы не потому, что они глупые, а потому, что они не профессионалы в данной области, они не знают всех технических возможностей и невозможностей. Поэтому есть мы — мы подходим к решению каждой бизнес-задачи системно, прилагая все усилия, чтобы понять корень проблемы, и тогда предлагаем такое решение, которое максимально автоматизирует ваши процессы, и при этом будет соответствовать базовым принципам построения информационных систем, будет учитывать возможное развитие предложенных процессов.

=== А я все равно не скажу, это моя коммерческая тайна! ===
С нами нужно работать как с врачом: нужно просто <rspoiler text="доверять">Мы понимаем всю степень деликатности вопросов, и, если бы мы не соблюдали «врачебную тайну», наверное, не смогли бы столько лет успешно работать с нашими клиентами.</rspoiler>, а все, что не скажете сделает хуже только вам. Если это для вас не приемлемо — лучше пишите сами. Причем в прямом смысле сами лично, а не с помощью наемных программистов.

=== Почему на доработки требуется время ===

=== Как сделать быстрее ===
Задачи клиентов разбиты по [[#Задачи|приоритетам]].
* Чтобы повысить приоритет вашей задачи в общей очереди рассмотрения, заполните форму важности тикета. Форма доступна:
** по ссылке из письма от поддержи MeaSoft по тикету. Текст ссылки: «Это важная задача? Сообщите нам об этом!».
** в личном кабинете курьерской службы в пункте основного меню '''Тикеты'''. Текст ссылки: «Выделите тикет в таблице и укажите важность вашей задачи».
* Чтобы повысить приоритет задачи среди ваших тикетов, установите приоритет в колонке '''Приоритет''' в списке тикетов.

=== Как сделать дешевле ===
Давайте разговаривать! Сейчас при оценке задачи, ее объема и стоимости мы исходим из того, что есть некоторое ТЗ, которое нужно согласовать, реализовать и поддерживать. И всегда есть риск что-то не учесть, потратить на какой-то блок не 1 день, как планировалось, а неделю. Это все, конечно, приходится закладывать в цену и сроки. На рынке, однако, есть и другие способы взаимодействия. Например, мы можем совместно проработать экономику того или иного процесса, посчитать, сколько это должно приносить прибыли и отталкиваться от нее — как в сторону упрощения и удешевления разработки, так и, где это оправдано цифрами — сжатия сроков, установки более точной задачи и т. д.

=== Почему доработки стоят денег ===
Иногда наши клиенты говорят «Я же придумываю вам функциональность, которую вы включите в свою систему и она станет лучше, вы это будете продавать, почему я должен платить за разработку?» На это у нас есть ряд ответов:
* Мы практически не зарабатываем на продажах. На самом деле, мы и на доработках не зарабатываем. Продажи и доработки вместе составляют менее 15 % нашего оборота (см. [[#Бизнес-модель|бизнес-модель]]). А увеличение стоимости системы за счет какой-то отдельно взятой доработки и вовсе лежит в пределах погрешности любого измерения.
* Вся та функциональность, которая сейчас есть в системе, и которую вы приобретаете за смешные, для подобных систем, деньги, так же была до Вас кем-то придумана и оплачена, что позволяет вам сразу пользоваться всеми этими идеями.
* Мы, естественно, не все доработки делаем платно. При принятии решения о стоимости и сроках выполнения доработки мы опираемся на множество факторов, таких, как востребованность (возможно, потенциальная) другими нашими клиентами, трудозатратность, реальная необходимость доработки именно для Вашего процесса, обслуживаемость данной функциональности в будущем. И на практике, большинство доработок мы делаем по себестоимости. Некоторые — бесплатно, некоторые, если доработка нужна только вам, и больше о ней никто не спрашивал и подобных процессов больше ни у кого нет — то по рыночной цене. Бывают и такие доработки, за которые мы выставляем завышенный ценник, если видим, что подобная доработка может негативно сказаться на стабильности, скорости работы системы, ее масштабируемости. В этом случае ценой можно показать клиенту, что другое решение правильнее, дешевле, а клиент может, так же деньгами, сказать что ему это действительно нужно, что ему это выгодно, и он действительно будет этим пользоваться.
* Если бы мы принимали все идеи к разработке бесплатно, то каждый наш пользователь генерировал бы идеи каждый день, не заботясь о качестве этих идей, об их реальной востребованности в его процессе. Подходил бы с позиции «ну вы сделайте, вдруг пригодится». При этом наш ресурс разработки, как и любой другой ресурс в этом мире, ограничен. Поэтому задачи в работу принимаются либо платно, либо, если их выгода очевидна — бесплатно или дешево, либо, в рамках поддержки, но там тоже есть лимит трудозатрат, включенных в стоимость поддержки, поэтому клиенту приходится подходить ответственно к генерации идей.
* Не нужно считать нас «по ту сторону баррикад», пытаясь получить как можно больше за как можно меньше. Мы — продолжение вашей команды, ваши сотрудники. Мы для вас хорошо работаем, а вы — хорошо платите. Лично я всегда с удовольствием повышаю зарплаты сотрудникам. Если я повышаю, это значит сотрудник принес мне больше прибыли, значит я стал богаче. Сотрудник и дальше будет лучше работать и проносить еще больше прибыль! Это ли не повод для радости?
* Для еще более активного развития, решения ваших задач, нам нужно расширяться: нанимать больше программистов, руководителей, специалистов поддержки, платить им зарплаты. Экономя сейчас, пытаясь получить услугу бесплатно, вы стреляете себе в ногу: так завтра нам некем будет решать ваши задачи!

==== Интеграции ====
Наиболее «больная» тема платных разработок в последнее время — интеграции. Себестоимость разработки интеграции с партнером начинается от 100 т.р., и это объективная реальность. Почему? Дело в том, что в большинстве случаев, одна только техническая документация под API какой-либо компании — это 50-ти страничный документ, описывающий методы, поля, структуры данных и подходы к организации обмена информацией, как правило, чуждые нашей системе (и любой другой, кроме той, от которой приводится документация). Данные нужно адапировать. Статусы нужно транслировать. Далеко не всегда понятно, откуда именно брать требуемые данные, и куда складывать ответные, так как объектов, придуманных партнерами в нашей системе просто нет. В большинстве случаев на это еще накладывается «сырость» программного кода на чужой стороне — он работает не так, как описано в документации, и программисты на той стороне на ходу что-то дописывают и исправляют. В лучшем случае исправляют, а в худшем — они просто не идут на контакт. А в случае ошибки в передаче данных приходится поднимать всю историю, трассировать работу ПО, сравнивать данные и т. д. — это большая и кропотливая работа. Самое печальное, что через месяц-другой успешной работы, вдруг что-то ломается. Мы получаем негатив — клиент звонит с претензиями, что не может работать и т. д., мы сутки выясняем, в чем проблема, и оказывается, что партнер просто молча изменил свое API. Поэтому — да, мы делаем интеграции себе в убыток с такими популярными партнерами как СДЭК или Боксберри. Но если вам нужно интегрироваться с каким-то мало известным партнером, клиентом или сервисом — это стоит денег, причем скорее всего не только разработка интеграции, но и ее поддержка, так как сюрпризы подстерегают нас на всем протяжении совместной работы. Наиболее простые интеграции — с провайдерами SMS. Как правило, их API достаточно простое, и программист может его настроить за 1 рабочий день. Однако, это 5 т.р.+ обновление системы, которое тоже бывает платным. В большинстве случаев это не выгодно делать, если какой-то провайдер вам позвонил, и предложил цену сообщения на 3-5 копеек меньше, чем вы платите сейчас.

=== Почему доработки доступны всем ===
Иногда наши клиенты говорят «Я же сам придумал функциональность, и я оплачиваю ее разработку. Она должна быть нашим конкурентным преимуществом и не должна доставаться конкурентам». Отвечаю:
* Если доработка полезная еще кому-то: Представьте, что мы с вами договорились на такие условия — вы платите (с наценкой за эксклюзивность), мы делаем только для вас. Через месяц к нам приходит другой клиент и просит примерно тоже самое. Мы должны ему отказать в самой возможности реализации его хотелки? Или мы должны взять с него денег как за обычную, не эксклюзивную доработку, и открыть эту функциональность всем остальным?
* Если доработка не полезная другим: Я понимаю, что вы свято верите в то, что именно ваша идея — самая нужная всем. Но на практике — большинством доработок надо людей еще заставить пользоваться, если мы знаем, что они им полезны. А в других случаях и заставить не удастся.
* Вы тоже получаете все доработки от других клиентов. И из этого состоит вся наша система. Если бы все заказывали доработки только для себя — наша система не существовала бы. И вам пришлось бы нанимать программистов и писать систему самостоятельно с нуля. Собственно, что вам мешает сделать это сейчас? То, что наша система заведомо впереди? Это и доказывает правильность нашей политики разработки.

=== Примеры доработок ===

==== Правильные задачи ====
==== Не правильные задачи ====

==Почему обновления платные==
Вы купили систему и пользуетесь. В это время наши программисты работают, реализуют множество новых функций, улучшают существующие. Клиенты генерируют идеи, оплачивают их разработку, платят за поддержку, участвуют в тестировании новых функций. Согласитесь, не справедливо, если вы просто придете и все это даром получите? Так же сам процесс обновления связан с трудозатратами как на само обновление, так и дальнейшую поддержку. Обновление - это когда что-то меняется. А значит пользователей нужно обучать. Возможно - договариваться и перестраивать бизнес-процессы. Поэтому после обновления мы поддерживаем клиентов еще 2 недели. И чем больше времени прошло с последнего обновления - тем больше изменений, тем сложнее перейти на новую версию. Поэтому стоимость обновления зависит от времени, прошедшего с последнего обновления. Так же обновления входят в техническую поддержку по 2-му и 3-му тарифам.
=== А если я нашел ошибку? ===
Как я писал выше, в программе всегда есть ошибки, и есть что-то не очень работающее, чего могло и не быть. Соответственно, если бы мы обновляли при любом нахождении ошибки — люди выискивали бы мелкие ошибки специально. Если ошибка действительно серьезная — конечно мы сразу исправим и обновим. Такие ошибки, если они вдруг есть, всплывают сразу — у вас же бизнес-процессы постоянно происходят! Согласитесь, мало вероятно, что через год использования вы нашли какую-то проблему, которая делает невозможным ваши процессы.

=== Почему трудозатраты на исправление ваших ошибок записывают на меня? ===

# Всегда в любой системе есть что-то некрасивое. Если вы обратились с замечанием, а все пользовались так, значит вам это оказалось критично. Для того поддержка и есть, чтобы добавлять то, что вам нужно, и устранять то, что вам не нужно.
# На самом деле, даже когда это действительно наша ошибка, и она серьезная — вы обращаетесь в поддержку, создается тикет, и в рамках этого тикета исправляется. Другое дело, что что-то серьезное, как правило, решается совсем быстро, и, конечно, независимо от того, заказана у вас поддержка или нет.
# Мы всегда делаем больше, чем входит в тариф поддержки, чтобы вы были довольны. Даже если где-то будет исправление нашей ошибки по вашему тикету — чтобы это никто не считал. Мы же тоже можем посчитать…
# Ошибки бывают при любой разработке (которая у нас происходит непрерывно, чтобы в максимально реальном времени решать ваши бизнес-задачи). Какие-то ошибки, связанные с доработками по вашим тикетам, обнаруживают другие клиенты, и мы их исправляем в их поддержку, а какие-то другие — вы. И вы, в том числе, начинаете пользоваться доработками, заказанными другими клиентами. Эти трудозатраты на исправление ошибок — неотъемлемая часть любой доработки: каждая доработка состоит из формирования ТЗ, разработки, тестирования, исправления ошибок и дальнейшей поддержки, и это все трудозатраты, которые нужно учитывать на этапе появления идеи что-нибудь к системе добавить или изменить. Это все входит в изначальный план. Частично они «размазываются» равномерно на всех наших клиентов. Не думаете же вы, что на оплату программистов на исправление ошибок у нас есть какие-то отдельные, «свои» деньги, кроме тех, что платят нам клиенты? И мы эти средства, суммарно то, что платят нам клиенты, используем по назначению — совершенствуем систему, добавляем функциональность, исправляем ошибки, поддерживаем ее работоспособность.

=== А сейчас продается версия уже новее??? ===
Как-то у нас спрашивали "А как же так не справедливо - я купил программу год назад, и в ней не было такой функции. А сейчас она продается за те же деньги, уже с этой функцией, и те, кто покупают сейчас, ее получают бесплатно, а мне нужно заплатить за обновление". Объясняю: 10 лет назад за те деньги, за которые вы сейчас покупаете Iphone, продавались монохромные Siemens с кнопочками и полифонией. Но вы же не считаете, что зря купили тот старый телефон? Или что сейчас производители вас обманывают - подсовывают мех гораздо лучше (с)? Вопрос в том, что товар или услуга, которую вы приобретаете в конкретном времени и месте, за конкретные деньги, на этот данный момент вам выгоден. Вы же посмотрели рынок, посчитали окупаемость и выбрали то, что наиболее эффективно будет приносить прибыль в вашем бизнесе. И весь этот год зарабатывали на этой системе, в отличие от того, кто ее только сейчас покупает. Ну и, конечно, это же очень хорошо, что наша система постоянно развивается. На самом деле, это даже происходит не в какой-то жесткой конкурентной борьбе, а просто наши клиенты обращаются с потребностями, а мы их решаем. И каждый день делаем работу всех наших клиентов все более эффективной. Мы работаем на то, чтобы все ваши конкуренты, у которых нет нашей системы остались за бортом! А те, у кого есть - взаимовыгодно сотрудничали, и процветали.

Как с нами работать

2021-10-13T12:00:17Z

Johny: /* Почему мы задаем вопросы */

Уважаемый (потенциальный?) пользователь системы "Курьерская служба 2008"!

В этой статье я опишу теорию и практику взаимодействия с нашей компанией, отвечу на часто задаваемые вопросы касающиеся этого взаимодействия. Я постараюсь максимально открыто описать нашу кухню.
Обладая этой информацией Вам будет гораздо быстрее и проще решать свои задачи по автоматизации.

<div style="text-align: right;">''Руководитель MeaSoft<br>'''Евгений Милевский'''''</div>

==О системе==
На сегодняшний день система «Курьерская служба» отметила своё четырнадцатилетние. За это время её положительно оценили и активно с нами сотрудничают более 300 компаний. Наши партнёры находятся в разных странах: Россия, Казахстан, Украина, Белоруссия, Киргизия, Латвия. С помощью нашего сервиса ежедневно 4,5 тысячи курьеров доставляют 60 тысяч отправлений от 11 тысяч клиентов.
Сама созданная нами «Курьерская служба» состоит из 200 связанных друг с другом таблиц, в некоторых из которых встречается по 50 миллионов записей. Мы постоянно работаем над её совершенствованием, чтобы наши клиенты всегда были впереди конкурентов.

===Бизнес-модель===
Наших клиентов, как существующих, так и потенциальных (а еще больше, конечно, меня самого!) часто интересует вопрос успешности и финансовой стабильности нашей компании. Это естественно, т.к. в случае ухода компании с рынка покупатели системы лишаются поддержки и прочих сервисов, без которых система утрачивает возможность адаптироваться под меняющиеся условия рынка. С такой "мертвой" системы компании придется куда-то переходить в максимально сжатые сроки. Поэтому здесь я расскажу, как мы зарабатываем.

Я делю рынок курьерских компаний на 3 части:
*'''Мелкие компании''' - стартапы и прочее, со штатом до 10 курьеров. Такие компании не очень интересно автоматизировать - выигрыш производительности труда от ведения базы данных, штрих-кодирования, расчета зарплаты и т.д. - минимальный, если вообще есть. Такие компании неплохо (если такое слово вообще применимо к подобным компаниям) себя чувствуют и в экселе, а учет отправлений сводится к фразе "ну я тебе давал отправление, ты его доставил?". Понятно, что для вменяемой автоматизации у такой компании нет ни денег ни потребности. Мы на такие компании никогда не нацеливались, и в свое время у нас получался неплохой симбиоз с системами вроде "Аурамы", которая позволяла подобной компании начать работать "в один клик" за 3 копейки. Это позволяло компании слегка подрасти, и при приближении к 10 сотрудникам их система переставала справляться, они переходили в следующую категорию и приходили к нам. "Конкуренты" "выращивали" нам клиентов! В последнее время ситуация изменилась: подобные системы стали дороже нашей, и клиенты из данной категории стали к нам приходить сразу. Надо, может, приподнять цены уже наконец? Подумаю.
*'''Средние компании''' - со штатом курьеров от 10 до 200 курьеров. Это наша ниша рынка. Самая распространенная, созревшая к автоматизации. Здесь можно добиться действительно большого роста эффективности труда. В тоже время, как правило, компаниям из этой категории хватает функциональности нашей системы "из коробки", процесс внедрения прост и надежен. Хотелки по доработкам если и возникают, то уже в процессе работы, а не на старте, что сильно упрощает их реализацию.
*'''Крупные компании''' - более 200 курьеров. Данная ниша гораздо меньше предыдущих, компании как правило уже чем-то автоматизированы, что создает много проблем при внедрении: в "их" системе что-то было реализовано по-другому, пользователям всегда не удобно переучиваться, они устраивают саботаж. Бизнес-процессы уже отлажены, и встроиться в них, повторить, нужно практически без репетиции. Нужно вести длительные переговоры, совещания, анализировать бизнес-процессы, составлять ТЗ на доработки для тех участков, которые у них уже были как-то реализованы, дорабатывать без тестирования на продакшене, как мы любим. В общем, очень много непродуктивной деятельности. В проекте внедрения занято куча народа, всякого рода <rspoiler text="руководители направлений">Риторический вопрос: Сколько руководителей нужно привлечь к проекту, чтобы его провалить?</rspoiler> и даже "менеджеры самого среднего звена". Вероятность успеха проекта внедрения граничит с авантюрой. Такие клиенты у нас тоже есть, в основном выросшие из 2-й категории. Не бросать же людей из-за того, что они выросли! Мы в ответе за тех, кого приручили ©.

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

Итак, наши клиенты из второй группы, со средним чеком в районе 20 т.р. в месяц, но их [http://courierexe.ru/our_clients.htm достаточно]. У нас нет <rspoiler text="якорного">Какое правильное слово кто-то придумал для обозначения того, что тянет вниз, не дает двигаться куда нужно!</rspoiler> клиента: поступления от самого крупного клиента не превышают 5% всего бюджета. Это позволяет мне быть действительно не предвзятым и уверенным в надежности выстроенной структуры. Так же, очень важный момент: это позволяет мне не играть в политику, балансируя между "хочу" отдельных клиентов и правильностью разработки с точки зрения системы, а ставить во главу угла именно архитектуру, гибкость, масштабируемость и поддерживаемость системы.

Бюджет, в основном, складывается из регулярных платежей наших клиентов: за аренду и поддержку. Продажа системы, равно как и платная доработка, в финансовом отношении мало эффективна, т.к. это разовые вещи, на которых построить надежный прогнозируемый бюджет невозможно. Подобные разовые платежи в сумме обеспечивают нам 10-15% бюджета, что, согласитесь, пренебрежимо мало. Поэтому мы ориентируемся на долгосрочное взаимовыгодное сотрудничество со всеми нашими клиентами. Мы заинтересованы в росте бизнеса всех наших клиентов, и способствуем этому всеми доступными нам способами.

===Эффективность===
Моя главная задача - эффективность использования всех ресурсов для получения максимальной отдачи для бизнеса наших клиентов на каждый потраченный рубль. Для этого я применяю все возможные подходы. У каждого из этих методов есть свои плюсы и минусы, поэтому я постараюсь их все здесь описать, чтобы Вы понимали, откуда берутся некоторые минусы в работе с нами, и что Вы получаете взамен.
====Команда====
Для эффективной работы команда должна быть компактной. Оптимальный размер команды для разработки ПО - 7-15 человек. Это тот объем, который позволяет руководителю дотянуться до каждого сотрудника, проконтролировать работу, объединить усилия всех сотрудников в единый организм и комплексно, целенаправленно решать стратегические задачи. Понятно, что написать Windows с такой командой невозможно, ее нужно сильно расширять. Однако это требует существенного расширения сопутствующего персонала. К сожалению, речь идет не только о найме проект-менеджера на каждую группу по 7 человек (зарплаты которых измеряются сотнями тысяч рублей), но и раздутии штата прочими сотрудниками, напрямую в процессе разработки/сопровождения не занятыми, поскольку работу групп нужно координировать, большую задачу нужно разбить на блоки, требования, функциональность, методы тестирования, интерфейсы взаимодействия которых нужно полностью задокументировать. Объем технической документации при "правильном" подходе занимает больше времени и стоит дороже, чем сам процесс разработки. После разработки каждого куска его надо тестировать отдельными штатными единицами, а потом пытаться склеить эти блоки вместе. В случае же с компактной командой ее можно просто собрать вместе, и сказать: "Давайте сделаем вот это. Ты делаешь это, а ты - вон то, через 2 дня собираемся вместе и проверяем". Поэтому я стараюсь удержать размер команды в оптимальном диапазоне. Пусть мы не можем такими силами взяться за какие-то глобальные мегапроекты, зато предельно эффективно решаем конкретные текущие задачи, которые ставят перед нами наши клиенты.

Мы, конечно, разбираемся в предметной области. Я начинал свою карьеру с работы курьером еще в 2000-м году, потом в офисе курьерской службы. Коммерческий директор - обязательно с опытом руководящей работы в курьерской службе. Мы лично встречаемся, общаемся с клиентами. Остальные сотрудники обязательно начинают свою работу с изучения предметной области. Полное погружение в нее - обязательное условие нормальной работы каждого сотрудника. К сожалению, большинство разработчиков подходят к своей работе только с позиции "мы умеем писать код, нам заказчик скажет, что написать, мы сделаем". Лично сталкивался с "автоматизаторами", которые только от меня узнавали, что после распределения заказов по курьерам их нужно еще физически на складе сортировать, а не просто скинуть курьерам полученные списки. Поэтому мы прикладываем все усилия к тому, чтобы такими не быть.

====Задачи====
Для максимизации эффективности труда необходимо выполнять только самые эффективные задачи. Есть такое <rspoiler text="правило 20 и 80 процентов">20% людей выпивают 80% пива. 20% работы приносит 80% пользы.</rspoiler>. Конечно, мы не делаем только 20% работы, но делаем 90%. Как мы выбираем наиболее востребованные задачи, чтобы не работать впустую?
*Мы никогда не придумываем сами себе задачи. У нас есть много клиентов, которые "на местах" сталкиваются с живыми ситуациями, и передают нам свои пожелания. Зачем нам изобретать свой велосипед?
*К нам постоянно поступает множество "хотелок" от клиентов. Им нужно как-то выдавать приоритеты. Для этого я их делю на 2 категории. Первая категория содержит:
**То, что просят многие.
**То, без чего реально процесс у клиента не работает.
**То, что можно сделать быстро и без <rspoiler text="хвостов.">Бывает, что задача вроде быстрая и простая, но когда ее сделаешь, клиент начинает уточнять: "а нам надо не так, а сделайте вот так", и мы вязнем в переговорах, уточнениях того, что же ему на самом деле нужно, многократных переделках. А время идет и другие, серьезные задачи стоят. Такую задачу нужно поставить в очередь, запланировать на нее время чтобы все согласовать, утрясти и реализовать по четко поставленному ТЗ.</rspoiler>
**То, что входит в поддержку пользователей.
**То, за что <rspoiler text="платят.">Плата за доработку, как я буду писать ниже, не столько заработок, сколько демонстрация заинтересованности клиента в доработке. Так же, оплата работы предполагает установку конкретных сроков, которых мы должны придерживаться. Впрочем, что касается сроков, то выбирая между сделать наспех но к сроку, или завалить срок но сделать качественно я всегда выбираю второе.</rspoiler>
Вторая категория - все остальное:
**То, что просит только один клиент, и ему это не критично, он не считает это важным чтобы сделать платно.
**То, что <rspoiler text="очень объемное">Месяц работы программиста, например.</rspoiler>, а польза не очевидна.
**То, что <rspoiler text="не понятно, как делать.">Понятно, что было бы удобно, если бы программа сама доставляла отправления, или печатала на принтере зарплаты курьеров, но как это сделать мы ПОКА не знаем. Может придумаем в будущем?</rspoiler>
Естественно, сначала мы делаем задачи из первой категории, и по остаточному принципу - остальные (даже если в теме обращения написано "ОЧЕНЬ ВАЖНО!!!"). Такой подход приводит к тому, что некоторые задачи могут стоять в очереди вечно. Но их процент не очень большой, а сделать все и сразу попасть в светлое будущее, конечно, невозможно.

====Экстремальное программирование====
В своей работе в разной степени мы используем принципы [https://ru.wikipedia.org/wiki/Экстремальное_программирование экстремального программирования]. Мое самое любимое положение из него - код должен максимально быстро начинать приносить реальную пользу (прибыль!) нашим клиентам. При классическом подходе к разработке, как я уже писал, сначала пишется документация всей доработки, потом разбивается на подзадачи, реализуется, тестируется, отлаживается и т.д., на все это уходит куча времени и денег. Потом ее пытаются сдать заказчику, и тут оказывается, что задачу изначально не совсем так поняли. Чтобы этого всего избежать, мы сходу пишем небольшие куски, и сразу, даже без тестирования, отдаем заказчику. Да, при этом могут быть ошибки. Но заказчик сразу начинает пользоваться, решать свои бизнес-задачи, т.е. экономить деньги. Ошибки, замечания, пожелания, которые он обнаруживает уже в промышленной эксплуатации, а не на примере [https://ru.wikipedia.org/wiki/Научный_юмор#Сферический_конь_в_вакууме сферических коней в вакууме], как это делает тестировщик, в реальном времени передаются разработчикам и так же быстро устраняются. В результате мы получаем огромный прирост эффективности - в разы, если не на порядки. С одной стороны сильно сокращаются издержки на документирование, тестирование, случаи решения несуществующих задач, а с другой стороны - клиент получает самую свежую функциональность со скоростью горячих пирожков и сразу начинает на этом зарабатывать. Пусть эта функциональность и не обязательно полная или надежная - это лучше, чем ничего. Иногда задача даже может остаться не очень доделанной - главное, что она решает поставленную перед ней конкретную задачу на конкретных данных. Поэтому иногда бывает, что клиент пытается воспользоваться функцией, а она не работает, т.к. писалась для конкретной задачи. С точки зрения клиента это <rspoiler text="глюк">- Исправьте немедленно!!!</rspoiler>, а с нашей - это недофича, которой могло и не быть, и <rspoiler text="никто бы не узнал, что она могла быть">Если, конечно, она не заявлена в перечне функциональности системы: в этом случае мы должны обеспечить корректность ее работы в соответствии с документацией и/или здравым смыслом</rspoiler>.

====Коммуникация====
Для оперативного решения задач необходимо всегда быть в тесном контакте. В рамках поддержки мы работаем на расстоянии телефонного звонка, многие вопросы решаются в реальном времени. Для руководителей компаний на 3-м тарифе поддержки мы предоставляем еще больший сервис: они могут звонить лично мне на мобильный, и получать консультации на максимально высоком уровне. Прямо в реальном времени, находясь, например, на встрече, можно подключить нашу компанию в моем лице к диалогу!

====Бюрократия====

====Поддержка====
Поддержка системы является крайне важным элементом ее совершенствования. Когда мы видим, что с каким-то вопросом к нам обращаются регулярно - мы понимаем, что что-то там сделано не идеально, и это нужно исправлять.

====Эволюция====
Наша компания, как и наша система, растет. Примерно на 30% в год. Есть плюсы:
*Скорее всего мы не закроемся :-)
*Система становится все более функциональной, и "из коробки" позволяет решать все больше задач.
*Мы совершенствуем свои процессы, их надежность и эффективность постоянно повышаются. <spoiler text="Примеры">
*Когда-то документы оформлялись вручную, и лицензионные ключи на аренду также делались вручную. Ключ после оплаты можно было ждать неделю, старожилы помнят.
*Мы разработали и внедрили тикетную систему. Уже через несколько месяцев мы задавались вопросом "а как же мы работали до этого?". Сейчас через нее проходят все обращения, задачи. Она позволяет нам не потерять ни одного вопроса или хотелки (хотя не скрою, некоторые вопросы у нас могут висеть и очень долго, т.к. решения их пока нет. Но все-равно мы о них помним!)
*Недавно мы сделали интерактивное [https://home.courierexe.ru/whatsnew средство отслеживания изменений] в системе. Теперь в реальном времени можно смотреть, что сделали программисты, по каким тикетам, в каких блоках.</spoiler>
Но есть и минусы:
*Система становится все сложнее, и любая доработка в ней требует все больше усилий. Это общая беда больших систем: по подсчетам Microsoft программисты тратят 90% времени на поиск места в коде их ERP-систем, куда нужно внести изменение, и только 10% - на написание этих изменений.
*Уменьшается объем личного присутствия. Еще 5 лет назад я лично приезжал к каждому клиенту в Москве, с ноутбуком, и что-то для них дописывал. Но это и хорошо: компания гораздо лучше работает, когда она выстроена как система, а не ручное управление одним человеком.

==Отказ от ответственности==
==Что входит в покупку (аренду) системы==
==Что входит в поддержку==
===Тариф 1===

Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.

===Тариф 2===

* Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.
* Регулярное обновление программы до последней версии — 1 раз в месяц.
* Настройка системы под бизнес-процессы клиента в рамках возможностей, доступных без перекомпиляции программы и ее модулей (за исключением настройки модуля интеграции с внешними системами для импорта/экспорта данных во внешние системы) — не более 5-ти рабочих часов разработчика в месяц. В большинстве случаев это создание дополнительных отчетов и печатных форм, настройка автоматизации.

===Тариф 3===

* Консультации пользователей по телефону, e-mail и Skype, а также с использованием средств удаленного доступа.
* Регулярное обновление программы до последней версии — 1 раз в месяц.
* Настройка системы, доработка функциональности, в том числе с перекомпиляцией программы и/или ее модулей — не более 15-ти рабочих часов разработчика в месяц.
* 1 плановый выезд специалиста в месяц (в пределах г. Москвы).

==Оплата счетов==

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

Мы знаем, что бывают форс-мажоры и долгая обработка платежа банком. Поэтому система продолжает работать до 7 числа следующего месяца и при каждом запуске напоминает о неоплаченном счете.

Мы добились минимальной стоимости системы за счет автоматизации многих процессов — в том числе и автоматизация рассылки ключей. Ключи рассылаются только после зачисления средств на наш расчетный счет.

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

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

*'''Обратиться "по адресу"''' Обратиться в поддержку можно по будням '''(а теперь и в выходные с 10 до 18!)''' (в соответствии с трудовым календарем Российской Федерации) с 8:00 до 21:00 по московскому времени любым удобным для Вас способом: Почта [mailto:support@courierexe.ru support@courierexe.ru], Телефон +7 (495) 987-17-12, бесплатный по России 8 (800) 707-90-35 или skype: courierexe, courierexe1, courierexe2, courierexe3.

*'''Представиться''' При обращении любым из способов Вам понадобится представиться: назвать ФИО и компанию, в которой Вы работаете. Возможно, продиктовать телефон и адрес электронной почты для обратной связи. В случае отсутствия данной информации (особенно по почте) специалисты технической поддержки, прежде чем начать решать проблему, сначала будут выяснять эту информацию, на что уходит драгоценное время. Мы не принимаем анонимки ни в каком виде! Особенно частая ошибка - когда пользователи пишут с общей почты организации, вида "info@courier.ru" и в подписи, вместо контакта человека написано что-то вроде "С уважением, команда курьерской службы". Нужна конкретная заявка от конкретного человека: мы должны знать, с чем работаем.

*'''Предоставить полную информацию''' Очень важно предоставить исчерпывающую информацию о своем вопросе. Номер заказа, с которым возникла проблема, или название клиента, если проблема с клиентом. Обратите внимание: если проблема касается сразу группы заказов – это хорошо, что Вы например, заметили "Во всех позавчерашних заказах происходит ...", и это даже может нам помочь, но номер конкретного заказа, хотя бы одного из той группы, нужно назвать. Сотрудник технической службы должен увидеть проблему, иначе может случиться так, что, просмотрев несколько заказов и не увидев никаких ошибок, он сочтёт, что дело в «человеческом факторе» и закроет тикет. Это абсолютно нормально и логично: люди ошибаются намного чаще машин! Если вопрос по отчету – укажите точную последовательность действий для его получения, какие пункты меню выбирали, какие данные вводили, приложите сам отчет. Если загружаете файлы – обязательно приложите исходные файлы и опишите, как загружаете. Будьте точны в формулировках! Неправильно сформулированное описание проблемы может привести к тому, что наш специалист будет искать возникшую проблему совсем не там, где она находится, и потеряет Ваше и наше время. Например, после получения формулировки "В подключении дата стоит не такая" последует вопрос о том, что же такое, в Вашем представлении "подключение", и эту потерю времени можно предотвратить, указав понятные нашим сотрудникам термины, а еще лучше – приложить скрин-шот, на котором было бы сразу видно, и какую именно Вы имеете в виду дату.

*'''Убедиться в создании задачи''' При любом обращении сотрудник технической поддержки должен создать так называемый "тикет" - это номер обращения по одному конкретному вопросу, в рамках которого решается Ваша задача. Тикет - это крайне удобное средство контроля за выполнением задач, он гарантирует, что ни один вопрос не потеряется бесследно. О создании тикета Вам на электронную почту придет письмо. Так же, Вы можете просматривать свои тикеты в [https://home.courierexe.ru личном кабинете], и контролировать - что делается, а на что от Вас ожидают реакции.

Условия, описанные выше, нормальны и понятны любому здравомыслящему человеку, но часто из-за волнения, собственных проблем клиентов и по другим причинам мы получаем заявки без необходимых нам для выполнения поставленных задач сведений. Вместо быстрого и эффективного решения вопроса начинается длинная переписка с выяснением, кто и откуда прислал претензию и что же его, собственно, не устраивает.

'''Важно! Такие задачи, как наименее продуктивные, получают низший приоритет, поэтому потратьте пять минут и сформулируйте всё в деловом ключе: чётко, полно, объективно.'''

'''UPDATE''' В последнее время получил несколько вопросов о программе по Whatsapp'y на личный мобильный телефон с неизвестных номеров. Такие обращения сразу отмечаются как спам, и номера банятся. '''''Коллеги! Ну давайте уже уважать друг друга!'''''

===Контроль качества===
Если Вы не удовлетворены качеством решения Вашего вопроса, есть несколько способов повлиять на ситуацию:
*'''Проголосовать по телефону''' После окончания телефонного разговора с нашими специалистами, система предлагает поставить им оценку.
*'''Проголосовать из письма''' В письме об изменении тикета по Вашему обращению Вам предлагают выбрать оценку.
*'''Обратиться к директору''' По почте [mailto:admin@courierexe.ru admin@courierexe.ru] или, в экстренных ситуациях, даже телефону: +7 (916) 114-79-92. При обращении нужно представиться, назвать номер тикета и/или максимально точное время телефонного общения с нашими сотрудниками - я лично подниму историю вопроса, записи телефонных разговоров, дам оценку ситуации и обязательно приму меры! Надо понимать, что голословные, не проверяемые, претензии вроде "я звонил когда-то, не помню когда, и мне плохо ответили" я принять не могу.

===Почему не нужно обращаться к программистам или директору===

Ответ на этот вопрос очевиден: первое, что Вас спросят: какой ответ Вы получили, обратившись в службу поддержки? Не забывайте, что все мы – люди, у всех есть масса важных и нужных дел, и отрывать от них и требовать внимания к себе в обход наших внутренних корпоративных правил – не лучший способ заручиться нашей поддержкой. Вас просто направят прочитать, кому нужно звонить в случае возникновения проблем, а приоритет Вашего дела может быть понижен.

==Почему вы не сообщаете об изменениях?==
===Текущие изменения функциональности и логики работы===
Сообщаем, и постоянно! На [https://home.courierexe.ru/whatsnew специальной странице] в реальном времени публикуются все изменения. Зайдите и посмотрите на нее.

Вряд ли вы хотите ежедневно получать длинные простыни с различными изменениями и дополнениями, вносимыми в программу. Поэтому мы публикуем краткие новостные подборки специально для наших клиентов в наших группах в [https://vk.com/measoft ВК], [https://facebook.com/courierexe Facebook] и в [https://t.me/measoft Telegram-канале]. Подписывайтесь!

Любое изменение вначале анализируется на предмет того, оно отразится на работе существующих процессов наших клиентов. Мы подходим к этому с особой тщательностью. Именно поэтому нам очень важно знать, как вы используете систему, и стараться своевременно предотвратить использование ее механизмов не по назначению. Однако клиентов у нас сотни, процессов у них тысячи, а мы одни, и поэтому иногда, очень редко, бывают и несовместимые изменения, которые мы всегда стараемся быстро исправить, если так случилось. Единственный способ это надежно предотвратить - никогда ничего не менять. Не делать никаких доработок, не обновлять систему клиентам, не добавлять новых функций, интеграций, поддержки нового оборудования и т.д. Наверное, это не совсем то, что вы ожидаете от поставщика ПО, верно?

===Добавление новых функций===
Мы постоянно добавляем новые функции, расширяющие возможности системы. Однако на работу такой функции оказывают влияние тысячи процессов, уже происходящих в системе. Поэтому мы вначале тестируем её на внутренних серверах, да и потом долгое время следим за корректностью её работы: собираем информацию об опыте использования, дописываем, улучшаем, переделываем. Поэтому, сразу после выхода новую функцию нет смысла документировать – она еще будет меняться и не раз.
В случае возникновения погрешностей – в процессе эксплуатации они выявляются и устраняются. У программистов есть такая поговорка "Каждая последняя ошибка, найденная в программе, на самом деле является предпоследней". Т.о. мы никогда не можем сказать, какой-то процесс идеален. Он может быть таковым до очередного улучшения, которое начнёт с ним конфликтовать, или возникновения ещё какой либо особой ситуации.

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

Отсюда вытекает понимание, что у новой функции нет одного момента, когда она становится продуктом, и о ней нужно всем сообщить. Есть только постепенно растущая степень нашей уверенности в этой функции. Если Вы ранее обращались к нам с вопросом о добавлении подобной функции – мы стараемся об этом помнить, и сообщить Вам о ней, но это тоже не всегда возможно. Поэтому рекомендуется периодически просматривать вики – как различные описания функций, так и страницу истории версий.

== Как доработать функциональность ==

=== Почему мы задаем вопросы ===
[[Файл:Workflowrus.jpg|thumb|450px|right|Старый баян о недопонимании при разработке, заботливо переведенный на русский для вас лично мной.]]
Полезно почитать на тему: '''[https://ru.wikipedia.org/wiki/%D0%9F%D1%8F%D1%82%D1%8C_%D0%BF%D0%BE%D1%87%D0%B5%D0%BC%D1%83 Пять почему]'''.

Как я уже писал, в день в среднем мы обрабатываем 30 обращений. Из них 2-3 звучат примерно как «А добавьте в карточку курьера галку „Выдан фирменный портфель“» (№ 1) или «А сделайте, чтобы на каждый район на карте можно было назначить отдельного курьера на каждый день недели» (№ 2). «А добавьте в отчет „количество доставок по клиентам“» поле «Среднее отношение количества выездов курьера к километражу между точками, умноженному на средний счет клиента» (№ 3).

За ~200 рабочих дней в году мы добавили бы минимум 500 таких галок, кнопок и полей, а за 10 лет — 5000. На самом деле — гораздо больше, так как они тянут друг друга.

По первому примеру: — А завтра вы, наверное, попросите добавить галку «Выдан планшет», а потом «Выдан проездной», плащ-палатка, футболка и солнечные очки? Клиент говорит «Ну, видимо, да…». Представляете, насколько система была бы не управляема сейчас? На практике, конечно, мы находим решение задач, главное — понимать, что именно он хочет. В данном случае клиенту нужно учитывать выдачу сотрудникам и прием неограниченного количества видов инвентаря. И так в модуле складского учета, в номенклатуре, появилась галка «<rspoiler text="инвентарь">Сейчас она уже преобразилась в выпадающий список „Тип номенклатуры“, поскольку наши клиенты пожелали еще вести учет расходных материалов вроде „незамерзайки“, и упаковки, которую система еще и [[Модуль складского учета#Расчет упаковки|подбирать]] под конкретные товары умеет!</rspoiler>», и клиент, помимо того, что просил, получил еще средство контроля за остатками своих фирменных портфелей на складе.

По второму пункту — понятно же, что в 95 % случаев на одном районе курьер будет работать каждый день недели, а то, что в выходные у них работает другой курьерский состав на тех же районах — это исключение. С гораздо большей вероятностью, вместо разных курьеров по дням недели, нашим клиентам понадобятся разные курьеры в зависимости от массы отправления (пешие/вело/авто курьеры), или срочности. Если бы мы добавляли возможность указания разных курьеров для всех этих вариаций (а сколько их еще можно придумать!), схемами на карте стало бы невозможно пользоваться. Понимая задачу, которую решает клиент, мы делаем возможность копирования схем. И клиент может нарисовать районы, скопировать схему, и 2 схемы назвать «будни» и «выходные», и назначить разных курьеров. А можно — сделать 7 схем по дням недели. А можно — отдельно для пеших, и отдельно — для автокурьеров.

По третьему эпизоду совсем все просто: Делается отдельный отчет в «доп. возможности», в котором выводятся те показатели, которые нужны клиенту, считающиеся по его ТЗ.

Очень частая проблема недопонимания: отчеты. Обращается клиент с просьбой добавить ему в раздел «Адреса» какое-то поле, например, количество поездок по отправлению в выдаче. На самом деле, добавление такого поля практически исключено по чисто технической причине: для вывода отправлений серверу придется для каждого из них «заглядывать» в «выдачу», и считать их количество. Для 99,999 % задач, решаемых пользователями в адресах, эти данные не нужны, но их расчет будет происходить, и замедлять работу всех систем всех наших клиентов. Но возникает и другой вопрос: «зачем вам это поле?». А клиент говорит «Мы будем выводить это поле, выгружать все 10 тыс. заказов с ним в эксель, там формулами считать наценку за лишние поездки, а потом загружать обратно этот эксель с рассчитанными ценами. Сейчас у нас круглосуточно работают 3 человека, которые в каждое отправление заходят, открывают закладку „История выдачи“, смотрят, сколько там строк, и вписывают в эксель.» Занавес! :-) Чтобы вы понимали — я не сильно утрирую, когда это пишу: люди действительно совершают ненужные подвиги каждый день. Здесь, если подходить формально, можно просто сказать «Нет, мы этот столбец не добавим». Если немного подумать — можно сделать отдельный отчет, который выведет в эксель требуемый клиентом показатель. Но если подойти к задаче действительно качественно, то в тариф клиента можно добавить услугу повторной доставки, которая сразу будет рассчитываться по тому алгоритму, который нужен клиенту, и процесс расчетов в экселе выпадет полностью, значительно упростив всем жизнь. Чем мы и занимаемся. '''Главный принцип хорошего программиста гласит «Клиенту надо дать не то, что он просит, а то, что ему действительно нужно».''' Тут вы, наверное, думаете, что пишут вам тут про каких-то дураков, а вы-то (именно вы!) действительно знаете, как правильно решать вашу проблему, и не нужно больше ничего выяснять, надо делать то, что вы говорите. Но на самом деле люди придумывают такие неконструктивные подходы не потому, что они глупые, а потому, что они не профессионалы в данной области, они не знают всех технических возможностей и невозможностей. Поэтому есть мы — мы подходим к решению каждой бизнес-задачи системно, прилагая все усилия, чтобы понять корень проблемы, и тогда предлагаем такое решение, которое максимально автоматизирует ваши процессы, и при этом будет соответствовать базовым принципам построения информационных систем, будет учитывать возможное развитие предложенных процессов.

=== А я все равно не скажу, это моя коммерческая тайна! ===
С нами нужно работать как с врачом: нужно просто <rspoiler text="доверять">Мы понимаем всю степень деликатности вопросов, и, если бы мы не соблюдали «врачебную тайну», наверное, не смогли бы столько лет успешно работать с нашими клиентами.</rspoiler>, а все, что не скажете сделает хуже только вам. Если это для вас не приемлемо — лучше пишите сами. Причем в прямом смысле сами лично, а не с помощью наемных программистов.

=== Почему на доработки требуется время ===

=== Как сделать быстрее ===
Задачи клиентов разбиты по [[#Задачи|приоритетам]].
* Чтобы повысить приоритет вашей задачи в общей очереди рассмотрения, заполните форму важности тикета. Форма доступна:
** по ссылке из письма от поддержи MeaSoft по тикету. Текст ссылки: «Это важная задача? Сообщите нам об этом!».
** в личном кабинете курьерской службы в пункте основного меню '''Тикеты'''. Текст ссылки: «Выделите тикет в таблице и укажите важность вашей задачи».
* Чтобы повысить приоритет задачи среди ваших тикетов, установите приоритет в колонке '''Приоритет''' в списке тикетов.

=== Как сделать дешевле ===
Давайте разговаривать! Сейчас при оценке задачи, ее объема и стоимости мы исходим из того, что есть некоторое ТЗ, которое нужно согласовать, реализовать и поддерживать. И всегда есть риск что-то не учесть, потратить на какой-то блок не 1 день, как планировалось, а неделю. Это все, конечно, приходится закладывать в цену и сроки. На рынке, однако, есть и другие способы взаимодействия. Например, мы можем совместно проработать экономику того или иного процесса, посчитать, сколько это должно приносить прибыли и отталкиваться от нее — как в сторону упрощения и удешевления разработки, так и, где это оправдано цифрами — сжатия сроков, установки более точной задачи и т. д.

=== Почему доработки стоят денег ===
Иногда наши клиенты говорят «Я же придумываю вам функциональность, которую вы включите в свою систему и она станет лучше, вы это будете продавать, почему я должен платить за разработку?» На это у нас есть ряд ответов:
* Мы практически не зарабатываем на продажах. На самом деле, мы и на доработках не зарабатываем. Продажи и доработки вместе составляют менее 15 % нашего оборота (см. [[#Бизнес-модель|бизнес-модель]]). А увеличение стоимости системы за счет какой-то отдельно взятой доработки и вовсе лежит в пределах погрешности любого измерения.
* Вся та функциональность, которая сейчас есть в системе, и которую вы приобретаете за смешные, для подобных систем, деньги, так же была до Вас кем-то придумана и оплачена, что позволяет вам сразу пользоваться всеми этими идеями.
* Мы, естественно, не все доработки делаем платно. При принятии решения о стоимости и сроках выполнения доработки мы опираемся на множество факторов, таких, как востребованность (возможно, потенциальная) другими нашими клиентами, трудозатратность, реальная необходимость доработки именно для Вашего процесса, обслуживаемость данной функциональности в будущем. И на практике, большинство доработок мы делаем по себестоимости. Некоторые — бесплатно, некоторые, если доработка нужна только вам, и больше о ней никто не спрашивал и подобных процессов больше ни у кого нет — то по рыночной цене. Бывают и такие доработки, за которые мы выставляем завышенный ценник, если видим, что подобная доработка может негативно сказаться на стабильности, скорости работы системы, ее масштабируемости. В этом случае ценой можно показать клиенту, что другое решение правильнее, дешевле, а клиент может, так же деньгами, сказать что ему это действительно нужно, что ему это выгодно, и он действительно будет этим пользоваться.
* Если бы мы принимали все идеи к разработке бесплатно, то каждый наш пользователь генерировал бы идеи каждый день, не заботясь о качестве этих идей, об их реальной востребованности в его процессе. Подходил бы с позиции «ну вы сделайте, вдруг пригодится». При этом наш ресурс разработки, как и любой другой ресурс в этом мире, ограничен. Поэтому задачи в работу принимаются либо платно, либо, если их выгода очевидна — бесплатно или дешево, либо, в рамках поддержки, но там тоже есть лимит трудозатрат, включенных в стоимость поддержки, поэтому клиенту приходится подходить ответственно к генерации идей.
* Не нужно считать нас «по ту сторону баррикад», пытаясь получить как можно больше за как можно меньше. Мы — продолжение вашей команды, ваши сотрудники. Мы для вас хорошо работаем, а вы — хорошо платите. Лично я всегда с удовольствием повышаю зарплаты сотрудникам. Если я повышаю, это значит сотрудник принес мне больше прибыли, значит я стал богаче. Сотрудник и дальше будет лучше работать и проносить еще больше прибыль! Это ли не повод для радости?
* Для еще более активного развития, решения ваших задач, нам нужно расширяться: нанимать больше программистов, руководителей, специалистов поддержки, платить им зарплаты. Экономя сейчас, пытаясь получить услугу бесплатно, вы стреляете себе в ногу: так завтра нам некем будет решать ваши задачи!

==== Интеграции ====
Наиболее «больная» тема платных разработок в последнее время — интеграции. Себестоимость разработки интеграции с партнером начинается от 100 т.р., и это объективная реальность. Почему? Дело в том, что в большинстве случаев, одна только техническая документация под API какой-либо компании — это 50-ти страничный документ, описывающий методы, поля, структуры данных и подходы к организации обмена информацией, как правило, чуждые нашей системе (и любой другой, кроме той, от которой приводится документация). Данные нужно адапировать. Статусы нужно транслировать. Далеко не всегда понятно, откуда именно брать требуемые данные, и куда складывать ответные, так как объектов, придуманных партнерами в нашей системе просто нет. В большинстве случаев на это еще накладывается «сырость» программного кода на чужой стороне — он работает не так, как описано в документации, и программисты на той стороне на ходу что-то дописывают и исправляют. В лучшем случае исправляют, а в худшем — они просто не идут на контакт. А в случае ошибки в передаче данных приходится поднимать всю историю, трассировать работу ПО, сравнивать данные и т. д. — это большая и кропотливая работа. Самое печальное, что через месяц-другой успешной работы, вдруг что-то ломается. Мы получаем негатив — клиент звонит с претензиями, что не может работать и т. д., мы сутки выясняем, в чем проблема, и оказывается, что партнер просто молча изменил свое API. Поэтому — да, мы делаем интеграции себе в убыток с такими популярными партнерами как СДЭК или Боксберри. Но если вам нужно интегрироваться с каким-то мало известным партнером, клиентом или сервисом — это стоит денег, причем скорее всего не только разработка интеграции, но и ее поддержка, так как сюрпризы подстерегают нас на всем протяжении совместной работы. Наиболее простые интеграции — с провайдерами SMS. Как правило, их API достаточно простое, и программист может его настроить за 1 рабочий день. Однако, это 5 т.р.+ обновление системы, которое тоже бывает платным. В большинстве случаев это не выгодно делать, если какой-то провайдер вам позвонил, и предложил цену сообщения на 3-5 копеек меньше, чем вы платите сейчас.

=== Почему доработки доступны всем ===
Иногда наши клиенты говорят «Я же сам придумал функциональность, и я оплачиваю ее разработку. Она должна быть нашим конкурентным преимуществом и не должна доставаться конкурентам». Отвечаю:
* Если доработка полезная еще кому-то: Представьте, что мы с вами договорились на такие условия — вы платите (с наценкой за эксклюзивность), мы делаем только для вас. Через месяц к нам приходит другой клиент и просит примерно тоже самое. Мы должны ему отказать в самой возможности реализации его хотелки? Или мы должны взять с него денег как за обычную, не эксклюзивную доработку, и открыть эту функциональность всем остальным?
* Если доработка не полезная другим: Я понимаю, что вы свято верите в то, что именно ваша идея — самая нужная всем. Но на практике — большинством доработок надо людей еще заставить пользоваться, если мы знаем, что они им полезны. А в других случаях и заставить не удастся.
* Вы тоже получаете все доработки от других клиентов. И из этого состоит вся наша система. Если бы все заказывали доработки только для себя — наша система не существовала бы. И вам пришлось бы нанимать программистов и писать систему самостоятельно с нуля. Собственно, что вам мешает сделать это сейчас? То, что наша система заведомо впереди? Это и доказывает правильность нашей политики разработки.

=== Примеры доработок ===

==== Правильные задачи ====
==== Не правильные задачи ====

==Почему обновления платные==
Вы купили систему и пользуетесь. В это время наши программисты работают, реализуют множество новых функций, улучшают существующие. Клиенты генерируют идеи, оплачивают их разработку, платят за поддержку, участвуют в тестировании новых функций. Согласитесь, не справедливо, если вы просто придете и все это даром получите? Так же сам процесс обновления связан с трудозатратами как на само обновление, так и дальнейшую поддержку. Обновление - это когда что-то меняется. А значит пользователей нужно обучать. Возможно - договариваться и перестраивать бизнес-процессы. Поэтому после обновления мы поддерживаем клиентов еще 2 недели. И чем больше времени прошло с последнего обновления - тем больше изменений, тем сложнее перейти на новую версию. Поэтому стоимость обновления зависит от времени, прошедшего с последнего обновления. Так же обновления входят в техническую поддержку по 2-му и 3-му тарифам.
=== А если я нашел ошибку? ===
Как я писал выше, в программе всегда есть ошибки, и есть что-то не очень работающее, чего могло и не быть. Соответственно, если бы мы обновляли при любом нахождении ошибки — люди выискивали бы мелкие ошибки специально. Если ошибка действительно серьезная — конечно мы сразу исправим и обновим. Такие ошибки, если они вдруг есть, всплывают сразу — у вас же бизнес-процессы постоянно происходят! Согласитесь, мало вероятно, что через год использования вы нашли какую-то проблему, которая делает невозможным ваши процессы.

=== Почему трудозатраты на исправление ваших ошибок записывают на меня? ===

# Всегда в любой системе есть что-то некрасивое. Если вы обратились с замечанием, а все пользовались так, значит вам это оказалось критично. Для того поддержка и есть, чтобы добавлять то, что вам нужно, и устранять то, что вам не нужно.
# На самом деле, даже когда это действительно наша ошибка, и она серьезная — вы обращаетесь в поддержку, создается тикет, и в рамках этого тикета исправляется. Другое дело, что что-то серьезное, как правило, решается совсем быстро, и, конечно, независимо от того, заказана у вас поддержка или нет.
# Мы всегда делаем больше, чем входит в тариф поддержки, чтобы вы были довольны. Даже если где-то будет исправление нашей ошибки по вашему тикету — чтобы это никто не считал. Мы же тоже можем посчитать…
# Ошибки бывают при любой разработке (которая у нас происходит непрерывно, чтобы в максимально реальном времени решать ваши бизнес-задачи). Какие-то ошибки, связанные с доработками по вашим тикетам, обнаруживают другие клиенты, и мы их исправляем в их поддержку, а какие-то другие — вы. И вы, в том числе, начинаете пользоваться доработками, заказанными другими клиентами. Эти трудозатраты на исправление ошибок — неотъемлемая часть любой доработки: каждая доработка состоит из формирования ТЗ, разработки, тестирования, исправления ошибок и дальнейшей поддержки, и это все трудозатраты, которые нужно учитывать на этапе появления идеи что-нибудь к системе добавить или изменить. Это все входит в изначальный план. Частично они «размазываются» равномерно на всех наших клиентов. Не думаете же вы, что на оплату программистов на исправление ошибок у нас есть какие-то отдельные, «свои» деньги, кроме тех, что платят нам клиенты? И мы эти средства, суммарно то, что платят нам клиенты, используем по назначению — совершенствуем систему, добавляем функциональность, исправляем ошибки, поддерживаем ее работоспособность.

=== А сейчас продается версия уже новее??? ===
Как-то у нас спрашивали "А как же так не справедливо - я купил программу год назад, и в ней не было такой функции. А сейчас она продается за те же деньги, уже с этой функцией, и те, кто покупают сейчас, ее получают бесплатно, а мне нужно заплатить за обновление". Объясняю: 10 лет назад за те деньги, за которые вы сейчас покупаете Iphone, продавались монохромные Siemens с кнопочками и полифонией. Но вы же не считаете, что зря купили тот старый телефон? Или что сейчас производители вас обманывают - подсовывают мех гораздо лучше (с)? Вопрос в том, что товар или услуга, которую вы приобретаете в конкретном времени и месте, за конкретные деньги, на этот данный момент вам выгоден. Вы же посмотрели рынок, посчитали окупаемость и выбрали то, что наиболее эффективно будет приносить прибыль в вашем бизнесе. И весь этот год зарабатывали на этой системе, в отличие от того, кто ее только сейчас покупает. Ну и, конечно, это же очень хорошо, что наша система постоянно развивается. На самом деле, это даже происходит не в какой-то жесткой конкурентной борьбе, а просто наши клиенты обращаются с потребностями, а мы их решаем. И каждый день делаем работу всех наших клиентов все более эффективной. Мы работаем на то, чтобы все ваши конкуренты, у которых нет нашей системы остались за бортом! А те, у кого есть - взаимовыгодно сотрудничали, и процветали.

Заглавная страница

2021-10-01T10:50:34Z

Johny:

__NOTOC__
Эта страница — оглавление документации к системе [http://courierexe.ru MeaSoft]. Мы постоянно работаем над улучшением документации. Все вопросы и предложения направляйте в службу технической поддержки.

Опубликованная документация описывает текущую версию системы. Если у вас установлена одна из предыдущих версий, то [http://courierexe.ru/contacts.htm обратитесь к нам] для обновления. Обновление может быть платным. Историю изменений программы смотрите на [https://home.courierexe.ru/whatsnew специальной странице].

Спасибо за то, что пользуетесь системой MeaSoft и принимаете участие в ее развитии!



==Содержание==

<table style="width: 100%;">
<tr>
<td style="text-align:right; padding-top: 20px">[[File:general.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Общий раздел</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:operator.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Работа с заказами</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:admin.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Настройка системы</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Как с нами работать]]</li>
<li>[[Справки о налоговом резидентстве]]</li>
<li>[https://home.courierexe.ru/whatsnew История изменений]</li>
<li>[[Файлы для загрузки]]</li>
<li>[[Видео уроки|Видеоуроки]]</li>
<li>[https://courierexe.userecho.com/ Часто задаваемые вопросы]</li>
<li>[[English Help]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Знакомство с программой|Знакомство с программой]]</li>
<li>[[Учет корреспонденции]]</li>
<li>[[Работа с заказами]]</li>
<li>[[Печать ведомостей и наклеек]]</li>
<li>[[Выдача корреспонденции курьерам]]</li>
<li>[[Отправка корреспонденции]]</li>
<li>[[Документы]]</li>
<ul>
<li>[[Приходные кассовые ордера]]</li>
<li>[[Путевые листы]]</li>
<li>[[Счета|Работа со счетами]]</li>
<li>[[Акты передачи денег и корреспонденции]]</li>
</ul>
<li>[[Учет наличных по бухгалтерии]]</li>
<li>[[Доска приема]]</li>
<li>[[Биллинг курьеров]]</li>
<li>[[Работа со срочными заказами]]</li>
<li>[[Направления (срочные заказы)|Направления срочных заказов]]</li>
<li>[[Модуль «Карта»#Планирование|Планирование доставок на карте]]</li>
<li>[[Импорт баз данных|Импорт заказов из Excel]]</li>
<li>[[Модуль складского учета|Складской учет]]</li>
<li>[[Работа с Почтой России]]</li>
<li>[[Отчеты]]</li>
<li>[[Задания]]</li>
<li>[[Честный ЗНАК]]</li>
<li>[[Функции|Дополнительные функции]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Начало использования]]</li>
<li>[[Настройка глобальных параметров]]</li>
<li>[[Настройка параметров рабочего места]]</li>
<li>[[Настройка модуля печати кассовых чеков]]</li>
<li>[[Настройка модуля автоматизации]]</li>
<li>[[Быстрый старт]]</li>
<li>[[Клиенты и партнеры]]</li>
<li>[[Сотрудники]]</li>
<li>[[Пользователи]]</li>
<li>[[Модуль «Карта»#Настройка|Модуль «Карта»]]</li>
<li>[[Тарифы]]</li>
<li>[[Работа с пунктами самовывоза (ПВЗ)|Добавление пункта самовывоза (ПВЗ)]]</li>
<li>[[Зарплата]]</li>
<li>[[Собеседования]]</li>
<li>[[Тикеты]]</li>
<li>[[Справочники]]</li>
<li>[[Охрана]]</li>
<li>[[Устранение неполадок]]</li>
<li>[[Оборудование]]</li>
<li>[[Дополнительные модули]]</li>
<ul>
<li>[[Модуль «Кросс-докинг»]]</li>
<li>[[Модуль отправки SMS-сообщений]]</li>
<li>[[Модуль репликации данных. ЛК клиента]]</li>
</ul>
<li>[[Интеграция с другими системами]]</li>
</ul>
</td>
</tr>
<tr>
<td style="text-align:right; padding-top: 20px">[[File:developer.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Для разработчиков</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:cabinet.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Сервисы</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:mobile.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Мобильные приложения</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Руководство программиста]]</li>
<li>[[API|API-интеграция]]</li>
<li>[[Пользовательские отчеты]]</li>
<li>[[Пользовательские поля]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Личный кабинет клиента]]</li>
<li>[[Личный кабинет курьерской службы]]</li>
<li>[[M-POINT]]</li>
<li>[[Дополнительные сервисы]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Мобильное приложение курьера для Android|Приложение курьера для Android]]</li>
<li>[[Мобильное приложение курьера для IPhone|Приложение курьера для iOS]]</li>
<li>[[Мобильное приложение кладовщика для Android|Приложение кладовщика для Android]]</li>
</ul>
</td>
</tr>
</table>

==Наши контакты==

<div style="font-size: 13px; overflow: hidden; min-width: 400px;">
<div style="overflow:hidden; margin-bottom: 20px;">
<div style="width: 40%; float: left;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>

<div style="float: left;">
<h3> Техническая поддержка </h3>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По будням </b> обращайтесь с 8:00 до 21:00 по московскому времени. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По выходным</b> помогаем вам с 10:00 до 18:00. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Email: [mailto:support@courierexe.ru support@courierexe.ru] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Телефон: +7 (495) 987-17-12, 8 (800) 707-90-35 </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Skype: courierexe, courierexe1, courierexe2, courierexe3, courierexe4, courierexe5 </p>

<p style="padding: 0; margin: 0; line-height: 19px;">
<spoiler text="Подробнее о поддержке">Перед обращением в поддержку, пожалуйста, поищите решение проблемы в этой документации и в сообществе пользователей [http://courierexe.userecho.com courierexe.userecho.com]. В сообществе вы можете оставить свой вопрос и мы обязательно на него ответим!

Если вы не нашли ответ и не оставили свой вопрос, то позвоните нам по телефону или Skype. Мы спросим ваше имя и название компании, которую представляете. Также будьте готовы оставить телефон для связи и заранее установите программу для подключения к вашему компьютеру: [https://download.teamviewer.com/download/TeamViewer_Setup.exe TeamViewer] или [http://www.ammyy.com/AA_v3.exe Ammyy Admin].</spoiler> </p>
</div>

<div style="float: left;">
<h3> Социальные сети </h3>
<p style="padding: 0; margin: 0; line-height: 19px;"> Мы доступны в социальных сетях! Там мы пишем об изменениях в системе и проводим голосования. Планируем публиковать обучающие видео. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://vk.com/measoft ВКонтакте] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://facebook.com/courierexe Facebook] </p>
</div>
</div>
</div>

<div style="width: 43%; float: right;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>
<div style="float: left; width: 100%;">
<h3> Сообщество пользователей</h3>

<p style="padding: 0; margin: 0; line-height: 19px;">
[http://courierexe.userecho.com courierexe.userecho.com]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Здесь вы можете предложить свою идею по улучшению или обсудить работу сервиса с другими
пользователями.
</p>
<p style="padding: 0; margin: 0; line-height: 19px;">

[https://t.me/measoft Telegram-канал]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Подпишитесь на наш канал и будьте уверены, что не пропустите важную для вашей работы<br>
новую функциональность! Обсуждайте обновления с другими пользователями и расскажите,<br>
что вы думаете о работе сервиса.
</p>
</div>
</div>
</div>

</div>

Заглавная страница

2021-10-01T09:47:09Z

Johny:

__NOTOC__
Эта страница — оглавление документации к системе [http://courierexe.ru MeaSoft]. Мы постоянно работаем над улучшением документации. Все вопросы и предложения направляйте в службу технической поддержки.

Опубликованная документация описывает текущую версию системы. Если у вас установлена одна из предыдущих версий, то [http://courierexe.ru/contacts.htm обратитесь к нам] для обновления. Обновление может быть платным. Историю изменений программы смотрите на [https://home.courierexe.ru/whatsnew специальной странице].

Спасибо за то, что пользуетесь системой MeaSoft и принимаете участие в ее развитии!

= Коллеги! На наш сервер в настоящий момент осуществляется [https://ru.wikipedia.org/wiki/DoS-%D0%B0%D1%82%D0%B0%D0%BA%D0%B0 DDOS атака]. Приносим извинения за временную недоступность наших сервисов. Мы активно работаем над отражением. Надеемся, скоро наладим. Благодарим за понимание. =

==Содержание==

<table style="width: 100%;">
<tr>
<td style="text-align:right; padding-top: 20px">[[File:general.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Общий раздел</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:operator.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Работа с заказами</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:admin.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Настройка системы</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Как с нами работать]]</li>
<li>[[Справки о налоговом резидентстве]]</li>
<li>[https://home.courierexe.ru/whatsnew История изменений]</li>
<li>[[Файлы для загрузки]]</li>
<li>[[Видео уроки|Видеоуроки]]</li>
<li>[https://courierexe.userecho.com/ Часто задаваемые вопросы]</li>
<li>[[English Help]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Знакомство с программой|Знакомство с программой]]</li>
<li>[[Учет корреспонденции]]</li>
<li>[[Работа с заказами]]</li>
<li>[[Печать ведомостей и наклеек]]</li>
<li>[[Выдача корреспонденции курьерам]]</li>
<li>[[Отправка корреспонденции]]</li>
<li>[[Документы]]</li>
<ul>
<li>[[Приходные кассовые ордера]]</li>
<li>[[Путевые листы]]</li>
<li>[[Счета|Работа со счетами]]</li>
<li>[[Акты передачи денег и корреспонденции]]</li>
</ul>
<li>[[Учет наличных по бухгалтерии]]</li>
<li>[[Доска приема]]</li>
<li>[[Биллинг курьеров]]</li>
<li>[[Работа со срочными заказами]]</li>
<li>[[Направления (срочные заказы)|Направления срочных заказов]]</li>
<li>[[Модуль «Карта»#Планирование|Планирование доставок на карте]]</li>
<li>[[Импорт баз данных|Импорт заказов из Excel]]</li>
<li>[[Модуль складского учета|Складской учет]]</li>
<li>[[Работа с Почтой России]]</li>
<li>[[Отчеты]]</li>
<li>[[Задания]]</li>
<li>[[Честный ЗНАК]]</li>
<li>[[Функции|Дополнительные функции]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Начало использования]]</li>
<li>[[Настройка глобальных параметров]]</li>
<li>[[Настройка параметров рабочего места]]</li>
<li>[[Настройка модуля печати кассовых чеков]]</li>
<li>[[Настройка модуля автоматизации]]</li>
<li>[[Быстрый старт]]</li>
<li>[[Клиенты и партнеры]]</li>
<li>[[Сотрудники]]</li>
<li>[[Пользователи]]</li>
<li>[[Модуль «Карта»#Настройка|Модуль «Карта»]]</li>
<li>[[Тарифы]]</li>
<li>[[Работа с пунктами самовывоза (ПВЗ)|Добавление пункта самовывоза (ПВЗ)]]</li>
<li>[[Зарплата]]</li>
<li>[[Собеседования]]</li>
<li>[[Тикеты]]</li>
<li>[[Справочники]]</li>
<li>[[Охрана]]</li>
<li>[[Устранение неполадок]]</li>
<li>[[Оборудование]]</li>
<li>[[Дополнительные модули]]</li>
<ul>
<li>[[Модуль «Кросс-докинг»]]</li>
<li>[[Модуль отправки SMS-сообщений]]</li>
<li>[[Модуль репликации данных. ЛК клиента]]</li>
</ul>
<li>[[Интеграция с другими системами]]</li>
</ul>
</td>
</tr>
<tr>
<td style="text-align:right; padding-top: 20px">[[File:developer.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Для разработчиков</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:cabinet.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Сервисы</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:mobile.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Мобильные приложения</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Руководство программиста]]</li>
<li>[[API|API-интеграция]]</li>
<li>[[Пользовательские отчеты]]</li>
<li>[[Пользовательские поля]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Личный кабинет клиента]]</li>
<li>[[Личный кабинет курьерской службы]]</li>
<li>[[M-POINT]]</li>
<li>[[Дополнительные сервисы]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Мобильное приложение курьера для Android|Приложение курьера для Android]]</li>
<li>[[Мобильное приложение курьера для IPhone|Приложение курьера для iOS]]</li>
<li>[[Мобильное приложение кладовщика для Android|Приложение кладовщика для Android]]</li>
</ul>
</td>
</tr>
</table>

==Наши контакты==

<div style="font-size: 13px; overflow: hidden; min-width: 400px;">
<div style="overflow:hidden; margin-bottom: 20px;">
<div style="width: 40%; float: left;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>

<div style="float: left;">
<h3> Техническая поддержка </h3>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По будням </b> обращайтесь с 8:00 до 21:00 по московскому времени. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По выходным</b> помогаем вам с 10:00 до 18:00. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Email: [mailto:support@courierexe.ru support@courierexe.ru] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Телефон: +7 (495) 987-17-12, 8 (800) 707-90-35 </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Skype: courierexe, courierexe1, courierexe2, courierexe3, courierexe4, courierexe5 </p>

<p style="padding: 0; margin: 0; line-height: 19px;">
<spoiler text="Подробнее о поддержке">Перед обращением в поддержку, пожалуйста, поищите решение проблемы в этой документации и в сообществе пользователей [http://courierexe.userecho.com courierexe.userecho.com]. В сообществе вы можете оставить свой вопрос и мы обязательно на него ответим!

Если вы не нашли ответ и не оставили свой вопрос, то позвоните нам по телефону или Skype. Мы спросим ваше имя и название компании, которую представляете. Также будьте готовы оставить телефон для связи и заранее установите программу для подключения к вашему компьютеру: [https://download.teamviewer.com/download/TeamViewer_Setup.exe TeamViewer] или [http://www.ammyy.com/AA_v3.exe Ammyy Admin].</spoiler> </p>
</div>

<div style="float: left;">
<h3> Социальные сети </h3>
<p style="padding: 0; margin: 0; line-height: 19px;"> Мы доступны в социальных сетях! Там мы пишем об изменениях в системе и проводим голосования. Планируем публиковать обучающие видео. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://vk.com/measoft ВКонтакте] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://facebook.com/courierexe Facebook] </p>
</div>
</div>
</div>

<div style="width: 43%; float: right;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>
<div style="float: left; width: 100%;">
<h3> Сообщество пользователей</h3>

<p style="padding: 0; margin: 0; line-height: 19px;">
[http://courierexe.userecho.com courierexe.userecho.com]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Здесь вы можете предложить свою идею по улучшению или обсудить работу сервиса с другими
пользователями.
</p>
<p style="padding: 0; margin: 0; line-height: 19px;">

[https://t.me/measoft Telegram-канал]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Подпишитесь на наш канал и будьте уверены, что не пропустите важную для вашей работы<br>
новую функциональность! Обсуждайте обновления с другими пользователями и расскажите,<br>
что вы думаете о работе сервиса.
</p>
</div>
</div>
</div>

</div>

Заглавная страница

2021-10-01T09:46:30Z

Johny:

__NOTOC__
Эта страница — оглавление документации к системе [http://courierexe.ru MeaSoft]. Мы постоянно работаем над улучшением документации. Все вопросы и предложения направляйте в службу технической поддержки.

Опубликованная документация описывает текущую версию системы. Если у вас установлена одна из предыдущих версий, то [http://courierexe.ru/contacts.htm обратитесь к нам] для обновления. Обновление может быть платным. Историю изменений программы смотрите на [https://home.courierexe.ru/whatsnew специальной странице].

Спасибо за то, что пользуетесь системой MeaSoft и принимаете участие в ее развитии!

= Коллеги! На наш сервер в настоящий момент осуществляется DDOS атака. Приносим извинения за временную недоступность наших сервисов. Мы активно работаем над отражением. Надеемся, скоро наладим. Благодарим за понимание. =

==Содержание==

<table style="width: 100%;">
<tr>
<td style="text-align:right; padding-top: 20px">[[File:general.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Общий раздел</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:operator.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Работа с заказами</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:admin.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Настройка системы</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Как с нами работать]]</li>
<li>[[Справки о налоговом резидентстве]]</li>
<li>[https://home.courierexe.ru/whatsnew История изменений]</li>
<li>[[Файлы для загрузки]]</li>
<li>[[Видео уроки|Видеоуроки]]</li>
<li>[https://courierexe.userecho.com/ Часто задаваемые вопросы]</li>
<li>[[English Help]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Знакомство с программой|Знакомство с программой]]</li>
<li>[[Учет корреспонденции]]</li>
<li>[[Работа с заказами]]</li>
<li>[[Печать ведомостей и наклеек]]</li>
<li>[[Выдача корреспонденции курьерам]]</li>
<li>[[Отправка корреспонденции]]</li>
<li>[[Документы]]</li>
<ul>
<li>[[Приходные кассовые ордера]]</li>
<li>[[Путевые листы]]</li>
<li>[[Счета|Работа со счетами]]</li>
<li>[[Акты передачи денег и корреспонденции]]</li>
</ul>
<li>[[Учет наличных по бухгалтерии]]</li>
<li>[[Доска приема]]</li>
<li>[[Биллинг курьеров]]</li>
<li>[[Работа со срочными заказами]]</li>
<li>[[Направления (срочные заказы)|Направления срочных заказов]]</li>
<li>[[Модуль «Карта»#Планирование|Планирование доставок на карте]]</li>
<li>[[Импорт баз данных|Импорт заказов из Excel]]</li>
<li>[[Модуль складского учета|Складской учет]]</li>
<li>[[Работа с Почтой России]]</li>
<li>[[Отчеты]]</li>
<li>[[Задания]]</li>
<li>[[Честный ЗНАК]]</li>
<li>[[Функции|Дополнительные функции]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Начало использования]]</li>
<li>[[Настройка глобальных параметров]]</li>
<li>[[Настройка параметров рабочего места]]</li>
<li>[[Настройка модуля печати кассовых чеков]]</li>
<li>[[Настройка модуля автоматизации]]</li>
<li>[[Быстрый старт]]</li>
<li>[[Клиенты и партнеры]]</li>
<li>[[Сотрудники]]</li>
<li>[[Пользователи]]</li>
<li>[[Модуль «Карта»#Настройка|Модуль «Карта»]]</li>
<li>[[Тарифы]]</li>
<li>[[Работа с пунктами самовывоза (ПВЗ)|Добавление пункта самовывоза (ПВЗ)]]</li>
<li>[[Зарплата]]</li>
<li>[[Собеседования]]</li>
<li>[[Тикеты]]</li>
<li>[[Справочники]]</li>
<li>[[Охрана]]</li>
<li>[[Устранение неполадок]]</li>
<li>[[Оборудование]]</li>
<li>[[Дополнительные модули]]</li>
<ul>
<li>[[Модуль «Кросс-докинг»]]</li>
<li>[[Модуль отправки SMS-сообщений]]</li>
<li>[[Модуль репликации данных. ЛК клиента]]</li>
</ul>
<li>[[Интеграция с другими системами]]</li>
</ul>
</td>
</tr>
<tr>
<td style="text-align:right; padding-top: 20px">[[File:developer.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Для разработчиков</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:cabinet.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Сервисы</h3></td>
<td style="text-align:right; padding-top: 20px">[[File:mobile.png|50px]]</td>
<td style="text-align:left; padding-top: 20px"><h3>Мобильные приложения</h3></td>
</tr>
<tr>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Руководство программиста]]</li>
<li>[[API|API-интеграция]]</li>
<li>[[Пользовательские отчеты]]</li>
<li>[[Пользовательские поля]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Личный кабинет клиента]]</li>
<li>[[Личный кабинет курьерской службы]]</li>
<li>[[M-POINT]]</li>
<li>[[Дополнительные сервисы]]</li>
</ul>
</td>
<td colspan="2" style="vertical-align:top; padding-left: 20px">
<ul>
<li>[[Мобильное приложение курьера для Android|Приложение курьера для Android]]</li>
<li>[[Мобильное приложение курьера для IPhone|Приложение курьера для iOS]]</li>
<li>[[Мобильное приложение кладовщика для Android|Приложение кладовщика для Android]]</li>
</ul>
</td>
</tr>
</table>

==Наши контакты==

<div style="font-size: 13px; overflow: hidden; min-width: 400px;">
<div style="overflow:hidden; margin-bottom: 20px;">
<div style="width: 40%; float: left;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>

<div style="float: left;">
<h3> Техническая поддержка </h3>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По будням </b> обращайтесь с 8:00 до 21:00 по московскому времени. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> <b>По выходным</b> помогаем вам с 10:00 до 18:00. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Email: [mailto:support@courierexe.ru support@courierexe.ru] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Телефон: +7 (495) 987-17-12, 8 (800) 707-90-35 </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> Skype: courierexe, courierexe1, courierexe2, courierexe3, courierexe4, courierexe5 </p>

<p style="padding: 0; margin: 0; line-height: 19px;">
<spoiler text="Подробнее о поддержке">Перед обращением в поддержку, пожалуйста, поищите решение проблемы в этой документации и в сообществе пользователей [http://courierexe.userecho.com courierexe.userecho.com]. В сообществе вы можете оставить свой вопрос и мы обязательно на него ответим!

Если вы не нашли ответ и не оставили свой вопрос, то позвоните нам по телефону или Skype. Мы спросим ваше имя и название компании, которую представляете. Также будьте готовы оставить телефон для связи и заранее установите программу для подключения к вашему компьютеру: [https://download.teamviewer.com/download/TeamViewer_Setup.exe TeamViewer] или [http://www.ammyy.com/AA_v3.exe Ammyy Admin].</spoiler> </p>
</div>

<div style="float: left;">
<h3> Социальные сети </h3>
<p style="padding: 0; margin: 0; line-height: 19px;"> Мы доступны в социальных сетях! Там мы пишем об изменениях в системе и проводим голосования. Планируем публиковать обучающие видео. </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://vk.com/measoft ВКонтакте] </p>

<p style="padding: 0; margin: 0; line-height: 19px;"> [https://facebook.com/courierexe Facebook] </p>
</div>
</div>
</div>

<div style="width: 43%; float: right;">
<div style="padding-left: 90px;">
<div style="width: 90px; float:left; margin-left: -90px;">
</div>
<div style="float: left; width: 100%;">
<h3> Сообщество пользователей</h3>

<p style="padding: 0; margin: 0; line-height: 19px;">
[http://courierexe.userecho.com courierexe.userecho.com]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Здесь вы можете предложить свою идею по улучшению или обсудить работу сервиса с другими
пользователями.
</p>
<p style="padding: 0; margin: 0; line-height: 19px;">

[https://t.me/measoft Telegram-канал]
</p>

<p style="padding: 0; margin: 0; line-height: 19px;">
Подпишитесь на наш канал и будьте уверены, что не пропустите важную для вашей работы<br>
новую функциональность! Обсуждайте обновления с другими пользователями и расскажите,<br>
что вы думаете о работе сервиса.
</p>
</div>
</div>
</div>

</div>

Руководство программиста

2021-09-24T10:17:49Z

Johny: /* Объект TBaseUtils */

== Основные положения ==

В систему «Курьерская служба 2008» встроен внутренний интерпретируемый язык программирования. Среда состоит из базовой функциональности, и дополнительно создаваемых объектов. Некоторые объекты автоматически создаются средой перед запуском интерпретатора для предоставления доступа к контексту, в котором работает скрипт. Все типы данных приводятся друг к другу автоматически, иногда при необходимости можно использовать функции приведения типов.

Как интерпретатор приводит типы:

1. При использовании значения как параметр функции интерпретатор автоматически приводит значение к типу, необходимому функции.

2. При операциях сложения, а также логических операциях, операнды приводятся к строке если хотя бы один из них имеет тип «строка». Например:
3.3+5 -> 8.3
‘3.3’+5 -> ‘3.35’
подобную проблему можно решить принудительно преобразовав тип:
float(‘3.3’)+5 -> 8.3

3. При операциях умножения, деления и вычитания операнды приводятся к числу с плавающей точкой, однако если результат выполнения операции получается целым числом, то он приводится к целочисленному типу.

Как работают функции приведения типов:

1. При преобразовании строки к числу: функция «читает» строку до первого символа, не позволяющего создать число с плавающей точкой, при этом разделителем целой и дробной частей может быть как точка так и запятая. Если приведение производится к целочисленному типу, то после этого происходит округление. Например:
float('3.6qwerty735') -> 3.6
int('3.6qwerty735') -> 4

2. При преобразовании к булевому типу ложью считается пустая строка либо число 0, все остальное - истина

3. При преобразовании булевого типа к числу истина преобразуется в 1, ложь – в 0. Такое преобразование позволяет использовать сложение и умножение в качестве логических «ИЛИ» и «И» соответственно:
if((5=5)+(6=7), <a>, [b]) – условие истинно, выполнится код «a».

4. При преобразовании булевого типа к строке сначала происходит преобразование к числу:
(5=5)+'qwerty' -> ‘1qwerty’

== Описание синтаксиса ==

Команды разделяются точкой с запятой. Параметры функций разделяются запятыми. Каждая команда (даже цикл while) является функцией, возвращающей некоторое значение. Результатом выполнения составной команды (последовательности функций, разделенных точкой с запятой), является результат выполнения последней функции. Имена переменных, функций, объектов, а также их свойств и методов не чувствительны к регистру.
Константы: константы бывают целочисленными, дробными и строковыми. Значения целочисленных и дробных констант указываются «как есть» (в этом случае разделитель целой и дробной частей – точка), шестнадцатеричные значения начинаются с символа «$» и, если первая цифра – буква, она упреждается цифрой 0, а строковые – в одинарных кавычках. При этом, если внутри строковой константы встречается символ одинарной кавычки он должен быть задвоен, для указания интерпретатору того, что он не является признаком конца константы.
Операции сравнения: >, <, =, ! - Больше, меньше, равно, не равно соответственно.
Логические операции: + (ИЛИ), * (И).
Арифметические операции: +, -, *, /
Операция конкатенации строк: +

=== Функциональность базового объекта ===

SET($a, a) – присваивает переменной (1-й параметр) значение второго параметра. При отсутствии переменной – создает ее. Имена переменных должны начинаться с символа «$», а следующий символ не должен быть цифрой. Возвращает новое значение переменной. Функция используется только для задания значений переменных. Не допускается использования для задания значений свойств объектов. Для этого используются соответствующие методы этих объектов.

IF(a,b,c) или IF(a,b) – Условный оператор. В первом случае возвращает b, если a истинно (не равно нулю или пустой строке), иначе – c. Во втором случае – возвращает a, если оно истинно, иначе – b.

WHILE(a, b) – Оператор цикла. Выполняет b пока a истинно:
set($i, 10);
set($sum, 0);
while($i>0, set($sum, $sum+$i); set($i, $i-1));
$sum
Результат – 55

FOR($a, b, c, d) – Оператор цикла. Выполняет d пока $a последовательно присваиваются значения от b до с включительно:
set($sum, 0);
for($i, 1, 10, set($sum, $sum+$i));
$sum
Результат – 55

NEW(ClassName, InstanceName) – Создает экземпляр класса ClassName, назначает ему имя InstanceName. Возвращает порядковый номер созданного объекта. Доступ к свойствам и методам объектов осуществляется по имени объекта и имени свойства/метода, разделенным точкой. Именем объекта может быть и пустая строка, тогда доступ к его свойствам и методам будет осуществляться без указания имени, и, в случае совпадения имен свойств и/или методов со стандартными или свойствами/методами других объектов, использоваться будут соответствующие свойства/методы объекта, созданного ранее, а также такой объект невозможно уничтожить до окончания выполнения скрипта. Все объекты созданные во время выполнения скрипта уничтожаются автоматически после окончания его выполнения.

FREE(InstanceName) – Уничтожает объект с именем InstanceName. Возвращает 0. В случае отсутствия объекта с заданным именем вызывает ошибку.

ShowObjects – Возвращает список созданных объектов – названия классов и имена.

ERROR(message) – Вызывает ошибку с текстом message.

SHOWMESSAGE(message) – Отображает диалоговое окно с текстом message, останавливает выполнение скрипта до закрытия окна пользователем.

SimpleAskUser(Message) – Выводит диалоговое окно с текстом Message и кнопками «Да» и «Нет». Возвращает 1, если пользователь нажал кнопку «Да», иначе – 0.

TRY(a) – Выполняет a в «защищенном от ошибки» режиме. Если в процессе выполнения a возникает ошибка, возвращает текст ошибки, иначе – 0 (ложь).

REM(….) – Код в скобках игнорируется (комментарий).

EXEC(FileName, Params, Wait, WindowState) – Запускает внешнее приложение FileName с параметрами Params. Если Wait истинно – ожидает завершение процесса. Для WindowState доступны следующие числовые значения:
0 - SW_HIDE
1 - SW_SHOWNORMAL (по-умолчанию)
3 - SW_MAXIMIZE
6 - SW_MINIMIZE
Функция возвращает истину если приложение запущено успешно. Иначе – Ложь.
В случае успеха, при параметре Wait – истина кладет в переменную $LastResult код завершения приложения.

=== Строковые функции ===

UpCase(s) – возвращает строку s в верхнем регистре.

LCase(s) – возвращает строку s в нижнем регистре.

Len(s) – возвращает количество символов в строке s.

Pos(s, substr) – возвращает номер первого символа первого включения подстроки substr в строку s, возвращает 0, если включения подстроки отсутствуют. Поиск не чувствителен к регистру.

Param(s, i) – возвращает i-й элемент строки s, разделенной запятыми на элементы.

ParamsCount(s) - возвращает количество элементов строки s, разделенной запятыми на элементы.

Left(s, i [,full] ) – возвращает i первых символов строки s. Параметр i, может быть строкой, тогда он считается разделителем и функция, возвращает строку слева от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Mid(s, i, j) - возвращает подстроку из s начиная с i символа и длиной j символов

Right(s, i [,full]) – возвращает i последних символов строки s. Параметр i, может быть строкой, тогда он считается разделителем, функция ищет разделитель с конца строки, и возвращает строку справа от разделителя. Параметр full разрешает функции вернуть всю строку s, если по параметру i ничего не нашли, параметр не обязательный, по умолчанию выключен.

Reverse(s) - возвращает строку s задом-наперед. Полезно например для поиска с конца функций Pos().

Char(i) – возвращает символ с кодом i.

Ord(s) – возвращает код первого символа строки s.

Replace(s, strFind1, strReplace1, [ strFind2, strReplace2, ... ], [caseInsensetive]) - возвращает строку s, в которой все включения строк strFind заменены строкой strReplace. Параметры поиска и замены всегда должны быть в паре и их может быть несколько. caseInsensetive - неучитывать регистр, не обязательный параметр, по умолчанию включен.

RemSpace(s) – возвращает сроку s без начальных и конечных запятых и пробелов, а также начальных точек.

SumStr(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''с добавлением валюты'''. Необязательные параметры captions - позволяет изменить название валюты, формат строки может зависеть от текущего языка(посмотреть формат можно в "Справочники"-"Статусы"-"32 Валюты", в разделе "Дополнительная информация"). Language - код языка на котором необходимо вывести сумму прописью. По умолчанию если не обязательные параметры опущены, используются региональные настройки в переменных.

NumToStrSimple(f [, captions, language]) – Возвращает сумму f, написанную прописью, по умолчанию '''без валюты'''. Параметры идентичны функции SUMSTR.

FullNameToShort(Name) – Возвращает фамилию и инициалы по полному ФИО Name.

MonthName1(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в именительном падеже.

MonthName2(m) – Возвращает имя месяца с номером m с большой буквы на русском языке в родительном падеже.

StrForXML(s) - Подготавливает строку к парсингу как xml: Если находит в строке подстроку "UTF-8" - перекодирует ее из utf-8 в win-1251, убирает начальный знак вопроса, если такой встречается.

FixedIntToStr(i, len[, char]) - Возвращает целое число i дополненное слева символами char (по-умолчанию - "0") до длины len.

Translate(format, [param1, param2, ...]) - Функция перевода строки format в язык пользователя. Строка format может содержать параметры %s, %d - строка и число соответственно.

====Функции перекодировки====
DecodeStr(s, charset) - Производит перекодировку строки s в кодировку CP1251. Кодировка строки s должна быть заранее известна и может быть :
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866, UNICODE. Имя кодировки следует передавать в точности без лишних символов.

EncodeStr(s, charset) - Производит перекодировку строки s в кодировку charset. Кодировка строки s должна быть CP1251, возможны следующие варианты перекодировки:
KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866. Имя кодировки следует передавать в точности без лишних символов. UNICODE не работает с версии 2021, в ней строки по умолчанию в кодировке unicode.

Функции EncodeBase64(s), DecodeBase64(s), UrlEncode(s), UTF8Encode(s), UTF8Decode(s), Str2UTF(s) - устарели, используйте EncodeStr, DecodeStr.

====Транслитерация====

Translit(s) - транслитерация строки русского текста s латиницей

UnTranslit(s) - транслитерация строки s с латиницы на русский.

==== Экранирование ====

QUOTEDSTR(s) – квотирует строку s символом «\» (обратный слеш). Возвращает строку s, помещенную между символами одинарной кавычки, при этом все вхождения в строку s символов: «\», «"» и «'» экранируются квотирующим символом, а символы #0, #10 и #13 заменяются на \0, \n и \r соответственно.

FormatTextXML(s) - квотирует строку s для использования в XML. Производит замены спец. символов для корректности XML-синтаксиса.

FormatTextJSON(s) - переводит строку в формат JSON, экранирует служебные символы.

====Хеширование ====

HMACHash256(key, text) - создаёт хэш по алгоритму SHA256 для проверки целостности сообщения, key - секретный ключ, text - хэшируемое сообщение

MD5Hash(text) - создаёт хеш по алгоритму MD5

SignatureUrl(url) - Подписывает переданный URL. Функция возвратит переданный URL с добавленным в конце параметром, в котором будет записана подпись.

=== Функции работы с датой и временем ===

CurrTime – возвращает текущее время

CurrDate – возвращает текущую дату

CurrMillisecond - Возвращает количество миллисекунд прошедших с начала текущего года. Используется для точного расчета временных интервалов.

Today - возвращает текущую дату в числовом формате.

Day(dt) – возвращает день месяца даты dt.

Month(dt) – возвращает месяц года даты dt.

Year(dt) – возвращает год даты dt.

DaysInMonth(month, year) – Возвращает количество дней в указанном месяце.

IncDay(dt, [count=1]) – Возвращает дату, увеличенную на count дней.

SQLDate(dt) – Пытается конвертировать dt в дату, вернуть в формате «'YYYY-MM-DD'» (с апострофами), если не удается – возвращает «NULL».

SQLDateToDate(dt) – Переводит дату из SQL-формата в обычный.

DAYSBETWEEN(dt1, dt2) – Возвращает количество дней между датами dt1 и dt2. В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimeBetween(t1, t2) - Возвращает количество минут между временем t1 и t2. Если t1 > t2 то будет показано количество минут между t2 и t1. Параметр t может быть как в формате "HH:MM", так и в числовом. Если один из параметров не удалось привести к числовому типу возвращает -1000.

WorkDaysBetween(dt1, dt2, [DecreaseFirstDay=0]) - Возвращает количество рабочих дней между датами dt1 и dt2. Параметр DecreaseFirstDay уменьшает dt1 на указанное количество дней (по умолчанию 0). В случае ошибки приведения dt1 или dt2 к дате возвращает -1000.

TimePeriod(time1, time2) - Оформляет временной период. Возвращаемое значение зависит от наличия значения в параметрах. Возможные варианты: "time1 - time2" , "С time1" , "ДО time2".

StrDateToFloat(s, [time=false]) - Переводит строку с датой s в числовой тип. Если параметр time включен, то в строке s должно быть указано время. Дата должна быть в формате "DD.MM.YYYY", а время "HH:NN". Если строку перевести не удалось возвращает 0

IsAWorkDay(dt) - Когда день dt является рабочим, возвращает true. Если произошла ошибка приведения даты возвращает -1000.

IncWorkDay(dt, [count=1]) - Прибавляет count рабочих дней к дате dt. Возвращает дату в числовом формате, если произошла ошибка приведения даты возвращает -1000. По умолчанию параметр count равен 1 и не является обязательным.

Sleep(n) - Задержка выполнения на n миллисекунд.

=== Функции приведения типов ===

INT(v) – возвращает значение типа “целое”, приводя вариантное значение v к числовому типу, а затем округляя его. В том числе используется как функция округления.

FLOAT(v) – возвращает значение типа “число”, приводя вариантное значение v к числовому типу, переводя в число цепочку символов до первого нецифрового символа (либо точки или запятой).

STR(v) – возвращает значение типа “строка”, приводя вариантное значение v к строковому типу.

Date(v) – возвращает дату, либо пустую строку, если не удается конвертировать v в дату

Time(v) – возвращает время, либо пустую строку, если не удается конвертировать v во время. Понимает числовое представление времени.

=== Математические функции ===

ROUNDUP(f) – округляет число f до ближайшего большего по модулю целого числа.

ROUNDDN(f) – округляет число f до ближайшего меньшего по модулю целого числа.

Money(f, CouldBeEmpty, ZeroFill, MakeSpace) - Округляет число f, до двух знаков после запятой. CouldBeEmpty - заменить число меньше 0,0001 на пустую строку. ZeroFill - Следить чтобы после запятой было два знака, если будет один, то добавить ноль. MakeSpace - Разделить разряды пробелом.

''Подсказка: для простого округления используется функция int()''

=== Константы ===

Null – Возвращает пустое значение.

Да, True, Нет, False – константы, соответствующие булевым значениям.

=== Прочие функции ===

SQLFloat(f) – Приводит число с плавающей точкой к виду, пригодному для SQL-запроса, т.е. к тексту с разделителем дробной части – точка.

SetPhoneParams(CountryCode, TownCode) – Устанавливает глобальные настройки кода телефонных кодов страны и города соответственно. По-умолчанию код страны – 7, код города – 495.

PhonesCount(s) – Возвращает количество корректных телефонных номеров, найденных в строке s.

GetPhone(s[, n]) – Возвращает n-й корректный телефонный номер, найденный в строке s. Нумерация начинается с 1.

GetEmail(s) – Возвращает все корректные адреса email, найденный в строке s, разделенные запятыми (т.е. готовыми к передаче в функцию SendEmail).

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject[, FileName]) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера (также к имени сервера можно добавить протокол ssl:// или tls://), порт, логин, пароль и email отправителя, разделенные символом переноса строки.

GenEan(ID, Code) – Формирует штрих-код EAN 13 Состоящий из идентификатора типа сущности ID и кода сущности Code, Выравнивает до 13-ти символов, первый – «2», последний – контрольная сума.

CheckEan(s) - Проверяет строку s, что она является кодом EAN13.

SaveToFile(FileName,s, encoding = '')- Создает текстовый файл по пути, указанному в FileName (если по указанному пути существует файл с указанным именем, он удаляется и создается новый) и производит запись строки s в созданный текстовый файл. encoding - название кодировки, по умолчанию сохраняет в кодировке ANSI. Доступные названия кодировок: KOI8-R, ISO-8859-5, UTF-8, URL, BASE64, QUOTED-PRINTABLE, CP866.

StrFromFile(FileName) - Читает файл FileName, возвращает в виде строки. При ошибке чтения вызывает ошибку.

DownloadAttachment(code, [savefilepath, tablename='attachment', fieldBlob='file', fieldLDtime='ldtime', fieldUID='uid']) - Функция выкачивает аттачмент из базы, по внутреннему коду - Code, всегда возвращает содержимое файла в виде строки, а также может сохранить файл по указанному пути в параметре savefilepath. По умолчанию, функция настроена на таблицу attachment. Code - внутренний код вложения, tablename - название таблицы, fieldBlob - название поля с содержимым файла, fieldLDtime - название поля с временем последнего изменения строки (для работы кэша). Функция использует кэш и умеет выкачивать файлы зауженные на внешние серверы (http, ftp,sftp, measoft). Для выкачивания с сервера measoft обязательно необходимо указывать параметр fieldUID.

DeleteFile(FileName) - Удаляет файл FileName с диска, возвращает истину, если операция прошла успешно и ложь - в противном случае.

HTTPPOST(host, PostParams, Proxy, ContentType, HTTPUser, HTTPPass, Method, CustomHeader, Reconnects) - Отправляет HTTP запрос по адресу host с данными PostParams. Proxy - объект Proxy, задающий прокси-сервер (по-умолчанию - пусто - не использовать прокси). ContentType - Заголовок ContentType. По-умолчанию - "application/x-www-form-urlencoded; Charset=UTF-8". HTTPUser и HTTPPass - данные для http-авторизации на сервере. Method - метод отправки запроса, по-умолчанию - "POST". CustomHeader - дополнение к заголовку, передается в виде списка параметров через запятую: 1 параметр - добавляет в заголовок SOAPAction, 2 параметр - Authorization. Reconnects - Количество попыток подключения (по-умолчанию - 2), если больше 100 - это таймаут единственной попытки подключения в милисекундах.
Функция возвращает ответ сервера. <br>
''Обратите внимание:'' Для имитации отправки данных html-формы методом POST может понадобиться перед передаваемыми параметрами добавить "Data=".

FTPPUT(host, User, Pass, FileName[, Active]) - Отправляет файл на FTP/SFTP-сервер. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

FTPGET(host, User, Pass, SourceFileName, DestFileName[, Active]) - Загружает файл SourceFileName с FTP/SFTP-сервера, сохраняет его в файл DestFileName. Параметр Host может иметь в себе путь к папке. По-умолчанию работает в пассивном режиме.

GetTempDir - Возвращает путь к временной папке.

ApplicationDir - Возвращает путь к файлу программы.

Interpretate(script) - Интерпретирует скрипт указанный в script. Выполнение происходит в текущем инстансе.

== Объект TExcel ==

Предназначен для доступа к данным документов MS Excel. Требует установленного приложения MS Excel.

Функции:

FileName – Возвращает имя текущего файла.

SetFileName(aFileName) – Задает значение свойства FileName.

Open - Открывает файл с именем, заданным свойством FileName. Если имя файла не задано - создает чистую книгу.

OpenFile(aFileName) – Выполняет функции SetFileName и Open.

LoadFromDB(DB[, Headered=true][, Col=1][, Row=1]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Если Headered истинно (по-умолчанию), таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются.

MyDB.Open('select * from kurier');
xl.LoadFromDB(MyDB.Self);
xl.DoNotDestroy(true);
xl.SetVisible(true);

Post2Sheet(DB[, Headered=true][, Col=1][, Row=1]) - Почти полный аналог LoadFromDB. В отличии от LoadFromDB если есть открытый файл, выгрузка данных будет выполнена прямо в него.

Align(x1, y1, x2, y2 [,HAlign, VAlign]) - Устанавливает выравнивание данных в указанном диапазоне. HAlign - горизонтальное выравнивание (0 – прижато влево , 1 – по центру , 2 – прижато вправо), VAlign - Вертикальное выравнивание (0 – прижато к верху , 1 – по центру , 2 – прижато к низу).

SetBorders(x1, y1, x2, y2) – Устанавливает границы прямоугольника. Если координаты опущены, или 0 – устанавливает границы всей используемой области.

DoNotDestroy(b) – При уничтожении объекта TExcel (а он уничтожается, как и все остальные объекты автоматически при завершении выполнения скрипта), приложение Excel уничтожается вместе с ним. DoNotDestroy(true) отключает уничтожение приложения.

SetVisible(b) – Устанавливает видимость приложения Excel для пользователя. По-умолчанию – false (не видимо).

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

Cell(x, y, text) – Возвращает значение ячейки, заданной координатами x, y. Необязательный булевый параметр text, в случае истинности, указывает на необходимость возврата данных с учетом формата ячейки, т.е. то, что пользователь видит на экране. Обратите внимание, что если в ячейке число, и ширина столбца не достаточна для отображения, Excel выводит "#####", что и будет возвращено программе, если text=ИСТИНА. Поэтому перед таким использованием рекомендуется выполнить функцию AutoFit.

SetCell(x, y, v[, x2, y2]) – Устанавливает значение ячейки, заданной координатами x и y, в значение v. Если заданы параметры x2, y2 - объединяет (merge) диапазон ячеек заданных координатами, устанавливает значение объединенной ячейки.

SetSheet(No) – Устанавливает номер текущего листа.

SetSheetName(Name) - Устанавливает название текущего листа.

Close – Закрывает текущий файл.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

ColCount - Возвращает количество столбцов в листе.

SheetsCount – Возвращает количество листов в книге.

AutoFit – Устанавливает автоматическую ширину столбцов.

RowAutoFit - Устанавливает автоматическую высоту строк.

RowInsert(i[, count]) - Вставляет count (по-умолчанию - 1) строк НАД строкой с номером i.

RowDelete(i[, count]) - Удаляет count (по-умолчанию - 1) строк начиная с номера i.

ColumnDelete(i[, count]) - Удаляет count (по-умолчанию - 1) столбцов начиная с номера i.

SheetDelete(i) - Удаляет лист с номером i.

SetRowHeight(r, h[, cnt]) – Устанавливает высоту cnt строк (по-умолчанию 1) начиная со строки r в h пикселей.

SetColWidth (c, w) – Устанавливает ширину столбца c в w символов.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки. Функция закрывает текущий файл, и не может использоваться для файлов, закрытие которых запрещено.

SetRowFontColor(Row,Color) - Устанавливает цвет шрифта в строке Row. Color - целое значение (RGB)

SetRowColor(Row,Color) - Устанавливает цвет фона в строке Row. Color - целое значение (RGB)

SetColumnFontColor(Col,Color) - Устанавливает цвет шрифта в столбце Col. Color - целое значение (RGB)

SetColumnColor(Col,Color) - Устанавливает цвет фона в столбце Col. Color - целое значение (RGB)

SetCellFontColor(Row,Col,Color) - Устанавливает цвет шрифта в ячейке с координатами [Row,Col]. Color - целое значение, равное номеру цвета в палитре (ColorIndex,не RGB)

SetCellColor(Row,Col,Color) - Устанавливает цвет фона в ячейке с координатами [Row,Col]. Color - целое значение (RGB)

GetRowFontColor(Row)- Возвращает RGB значение цвета шрифта строки Row

GetRowColor(Row)- Возвращает RGB значение цвета фона строки Row

GetColumnFontColor(Col)- Возвращает RGB значение цвета шрифта столбца Col

GetColumnColor(Col)- Возвращает RGB значение цвета фона столбца Col

GetCellFontColor(Row,Col) - Возвращает номер цвета шрифта в палитре (ColorIndex) в ячейке с координатами [Row,Col]

GetCellColor(Row,Col) - Возвращает RGB значение цвета фона в ячейке с координатами [Row,Col]

WrapText(x1, y1, x2, y2, value) – Устанавливает перенос текста прямоугольника в значение value. Если координаты опущены, или 0 – устанавливает границы всей используемой области. Для Value значение по-умолчанию - true.

SetOrientation(value) - Устанавливает ориентацию страницы. True (по-умолчанию) - альбомная (ландшафтная), Ложь - портретная.

Copy(x1, y1, x2, y2) - Копирует в буфер экселя

Cut(x1, y1, x2, y2) - Вырезает в буфер экселя

Paste(x1, y1) - Вставляет из буфера экселя. Команды copy-paste неразрывны, если что нибудь сделать в промежутке между ними, например вставить значение в ячейку, то копирование сброситься. (Последовательность использования: copy - paste, cut - paste)

PasteStyle(x1, x2, y1, y2) - Вставляет только оформление из буфера экселя (Последовательность использования: Copy - PasteStyle)

SetFont(Font[, x1, y1[, x2, y2]]) - Устанавливает шрифт Font для ячеек диапазона. Можно указать координаты только одной ячейки, можно - вообще не указать, тогда будет использован последний выделенный диапазон. Шрифт задается как обычно: 'Arial, 16, T, T, T', порядок параметров: Имя шрифта, размер, жирное начертание, курсивное начертание, одиночное подчеркивание. Если параметры не заданы, то у текущего шрифта они меняться не будут. Примеры: SetFont('Arial, 10, T, F, F', 1,1) - в ячейке A1 будет установлен шрифт Arial жирным начертанием (не курсив и без подчеркивания). SetFont(', , , T, F', 2,1) - в ячейке B1 будет поменяется только начертание курсив и будет отменено подчеркивание (если оно было).

InsertPicture(TPicture, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет рисунок на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

InsertFirmLogo(FirmCode, [x=1, y=1, DispX=0, DispY=0]) - Функция вставляет логотип фирмы с кодом FirmCode на текущий активный лист. x, y - координаты ячейки, относительно которых размещается рисунок, DispX, DispY - смещение рисунка относительно верхнего левого угла этой ячейки.

SheetFitPageWidth - устанавливает режим масштабирования печати, чтобы печатная форма помещалась в ширину на один лист.

PrintOut([copies]) - Печатает текущий лист на принтере по умолчанию. Параметр, copies - количество копий, по умолчанию равен 1.

CopySheetAfter([SheetFrom[, SheetAfter]]) - Копирует лист SheetFrom (по-умолчанию - текущий), создавая новый лист после листа SheetAfter (по-умолчанию - совпадает с копируемым).

Save(filename) - Сохраняет в файл filename. Если файл существует, в - основной системе он будет перезаписан, в других проектах - вызовет ошибку "Файл уже существует".

Пример использования:

new('TExcel', 'myxl');
myxl.OpenFile('c:\asdf.xlsx');
set($sum, 0);
while (myxl.EOF=0,
set($sum, $sum+int(myxl.c));
myxl.next );
$sum

''Возвращает сумму всех числовых данных столбца C файла 'c:\asdf.xlsx'''

== Объект TDirectExcel ==
Объект позволяет работать с файлами Excel напрямую, без установленного пакета MsOffice. Применяется в сервисах и при отсутствии экселя. Он максимально совместим с объектом TExcel, однако некоторые методы могут быть не реализованы.

== Объект TCSVFile ==
Предназначен для доступа к данным документов CSV. Разделителем столбцов является символ точка с запятой ;

Функции:

FileName – Возвращает имя текущего файла.

OpenFile(FileName) – Открывает файл FileName.

LoadFromDB(DB[, Headered=false]) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO.

LoadFromText(s) - Загружает таблицу из строки s.

RecNo – Возвращает номер текущей строки. Нумерация строк начинается с 1.

SetRecNo(aRecNo) – Устанавливает значение свойства RecNo.

A..ZZ – Возвращает значение соответствующего поля текущей строки. Может вызываться с целочисленным аргументом, указывающим на сдвиг относительно текущей строки. Например: AC(-1) – вернет значение столбца AC предыдущей строки. Если номер строки окажется вне допустимых значений вернет пустую строку.

First – Делает первую запись листа текущей.

Next – Увеличивает значение свойства RecNo на единицу в случае, если конец файла не достигнут. Иначе – выставляет свойство EOF в истину.

EOF – Возвращает признак достижения конца файла.

RecordCount – Возвращает количество строк в листе.

SendEmail(Server, Port, User, Pass, AddressFrom, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY).

SendEmail(EmailFromStr, AddressTo, MsgText, Subject) – Отправляет письмо по e-mail с указанными параметрами. В случае ошибки отправки вызывает ошибку (рекомендуется использовать совместно с TRY). EmailFromStr – строка, содержащая данные для отправки письма – адрес SMTP-сервера, порт, логин, пароль и email отправителя, разделенные символом переноса строки.

SaveToFile(Filename) - Сохраняет в файл с именем filename.

== Объект TADO ==

Предназначен для доступа к базам данных.

Функции:
{|
!Функция
!Описание
|-
|Connect(ConnectionString)
|Подключает к источнику данных. ConnectionString – Строка подключения ADO.
|-
|ConnectMySQL(DBServer, DBPort, DBUser, DBPass, DBName)
|Подключает к базе данных MySQL.
|-
|Open(Query)
|Открывает набор данных выполнив запрос Query.
|-
|FieldByNo(i)
|Возвращает значение поля с номером i. Нумерация полей – с нуля.
|-
|FieldName(i)
|Возвращает имя поля с номером i.
|-
|FieldCount
|Возвращает количество полей.
|-
|RecordCount
|Возвращает количество записей.
|-
|RecNo
|Возвращает номер текущей записи. ''ВНИМАНИЕ! В зависимости от способа подключения к БД нумерация может начинаться как с 0 так и с 1!''
|-
|EOF
|Возвращает признак достижения конца набора данных. Становится истиной когда выполняется команда Next на последней записи.
|-
|Next
|Переход на следующую запись набора.
|-
|First
|Переход на первую запись набора.
|-
|Last
|Переход на последнюю запись набора.
|-
|FieldByName(FieldName)
|Возвращает значение поля по имени. Также возможно указание имени поля как свойства объекта.
|-
|Field(Table, ID, FieldName)
|Возвращает значение поля FieldName записи с кодом ID таблицы Table. Набор данных, если он открыт, при этом не закрывается. Первичный ключ таблицы должен называться «code». Гарантированно работает только с MYSQL!!!
|-
|GetSQLValue(Query)
|Выполняет SQL-запрос. Текст запроса должен начинаться с первого символа строки (перед запросом не должно быть пробелов, переносов строк, комментариев и т.д.). Если запрос Insert – возвращает ID вставленной записи. Если запрос – Update, Delete, Replace, Set, Start, Commit, Rollback – возвращает количество измененных записей (RowsAffected), иначе – Select – значение первого поля первой строки результата как текст.
|-
|FillText(s)
|Возвращает строку s с замененными названиями полей между знаками процента на соответствующие значения текущей записи. Так же в строке возможно использование интерпретируемого кода, заключенного между тегами "<?>" и ">". При интерпретации система сначала производит замену полей с процентами на значения, потом интерпретирует код. ''Внимание! Функция не создает отельный контекст интерпретатора, а использует существующий, в нем доступны все объекты и переменные, вызывающего скрипта.'' Дополнительно автоматически создается объект TSelfADO, подключенный к той же БД, что и контекст, вызвавший функцию, с пустым именем, а так же с именем "dataset".
|-
|Query(Query)
|Синоним GetSQLValue.
|-
|Close
|Закрывает набор данных.
|-
|Self
|Возвращает указатель на подключение к БД для использования в других объектах.
|-
|ParseForIn([FieldName='code'])
|Возвращает через запятую значения всех строк в указанном столбце. По умолчанию, используется столбец с именем code.
|}

Пример использования – см. TSelfADO

== Объект TSelfADO ==

Наследник объекта TADO. Служит для подключения к «родной» для программы, в которой выполняется скрипт, базе данных. Обладает всеми свойствами и методами объекта TADO, кроме Connect. Иногда автоматически создается системой для обеспечения простого доступа к базе данных, а также иногда создается системой с уже открытым набором данных для передачи обрабатываемого системой набора данных в скрипт. В этом случае для скрипта недоступны функции Open и Close.

Пример использования:

rem('Копируем данные из "родной" базы данных в базу MSSQL.');
new('TSelfADO', 'MyDB');
new('TADO', 'MSSQL');
MSSQL.Connect('Provider=SQLOLEDB.1;Password=myPassword;Persist Security Info=True;User ID=myUsername;Initial Catalog=myDataBase;Data Source=myServerAddress');
MyDB.Open('select code, name, passport from kurier where code>'+Int(MSSQL.Query('select max(code) from kurier'))+' order by code');
While(MyDB.EOF=0,
MSSQL.Query('insert kurier (code, name, passport) VALUES ('+MyDB.Code+', '+QuotedStr(MyDB.Name)+', '+QuotedStr(MyDB.Passport)+')');
MyDB.Next;
);

== Объект TPrinter ==

Предназначен для доступа к принтерам.

Функции:

BeginDoc – Начинает новый документ.

EndDoc – Закрывает документ

PageHeight – Возвращает высоту страницы в пикселях

PageWidth – Возвращает ширину страницы в пикселях

PageNumber – Возвращает номер текущей страницы документа

Orientation – Возвращает текущую ориентацию страницы (0 – портретная, 1 – ландшафтная)

Printing – Возвращает истину если документ открыт

SetOrientation(Orientation) – Устанавливает ориентацию страницы. При необходимости начинает новый документ, новую страницу.

ShowDialog – Показывает пользовательский диалог печати. Возвращает истину, если пользователь нажал "OK".

NewPage – Начинает новую страницу

Canvas – Предоставляет доступ к объекту TCanvas, связанному с принтером.

PrinterNames – Возвращает список принтеров, установленных в системе, разделенный переносами строк

PrintersCount – Возвращает количество установленных в системе принтеров

SetPrinter(Printer) – Устанавливает текущий принтер. Если передана строка – ищет принтер по названию, иначе – по номеру. Нумерация начинается с 0.

PrintTable(Y, Table) – Выводит на печать таблицу Table типа TTable, начиная с координаты Y. При необходимости таблица печатается на нескольких страницах. Возвращает координату Y конца таблицы.

== Объект TCanvas ==

Предоставляет доступ к холсту объекта для прорисовки изображения.

Функции:

DPIX – Возвращает разрешение холста по горизонтали в точках на дюйм

DPIY – Возвращает разрешение холста по вертикали в точках на дюйм

TextOut(x, y, s[, x1, y1, x2, y2]) – Выводит строку s начиная с точки с координатами x и y. Если указаны параметры x1, y1, x2, y2 – то выводимый текст ограничивается заданным прямоугольником.

TextOutEx(x1, y1, x2, y2, Alignment, Font, s, Indent) – Выводит строку s в прямоугольнике с координатами x1, y1, x2, y2. По горизонтали строка выравнивается в соответствии с Alignment (0 – прижато влево, 1 – вправо, 2 – по центру), по вертикали выравнивается по центру. Используя шрифт Font (см описание ниже). Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату X фактического окончания текста (правой стороны – если строка прижата влево, и левой – в остальных случаях)

MLTextOut(x1, y1, x2, y2, Alignment, VAlignment, Font, s, Heigth, Indent) – Выводит многострочный текст s в прямоугольнике с координатами x1, y1, x2, y2 с переносом по словам. По горизонтали строки выравниваются в соответствии с Alignment, по вертикали – в соответствии с VAlignment (0 – прижато вверх, 1 – по центру, 2 – прижато вниз). Используя шрифт Font (см описание ниже). Heigth – высота строки. Если опущено или равно нулю – высота определяется автоматически в соответствии с выбранным шрифтом. Indent – отступ по горизонтали, расстояние в пикселях между границей прямоугольника и текстом. Функция возвращает координату Y фактического окончания текста (нижней границы последней строки текста. ''ВНИМАНИЕ! Функция использует координаты прямоугольника для позиционирования текста, однако она не ограничивает его верхней и нижней границами этого прямоугольника!''

DrawPic(x1, y1, x2, y2, Pic, Style, Alignment, Mode) – Прорисовывает изображение Pic (ссылка на изображение TPicture.Self) в прямоугольник заданный координатами x1-y2. Style – стиль масштабирования. 0 – растянуть изображение до границ прямоугольника не сохраняя пропорции, 1 – вписать изображение в прямоугольник сохраняя пропорции – вероятно, останутся поля по вертикали или горизонтали, 2 – вписать сохраняя пропорции, обрезав при необходимости изображение по вертикали или горизонтали. Alignment – выравнивание по горизонтали. Работает только в случае если style=1 и при растягивании изображения получились вертикальные поля. 0 – разместить по центру, 1 – прижать влево, 2 – прижать вправо. Функция возвращает координату X правой стороны изображения кроме случая, когда Style=1 и Alignment=2 – в этом случае возвращается координата левой стороны изображения. Mode - способ наложения изображения. 0 (по-умолчанию) - копирование как есть. 1 - Наложение операцией AND (применяется для получения эффекта прозрачности изображения), 2 - наложение операцией XOR (Применяется для возможности повторной операцией убрать изображение), 3 - Наложение операцией OR.

FillRect(x1, y1, x2, y2) – Рисует прямоугольник '''без границ''' и закрашивает цветом BrashColor

Rect(x1, y1, x2, y2) – Рисует прямоугольник '''c границами''', задаваемыми текущим пером, и закрашивает цветом BrashColor

SetFont(Font) – Устанавливает шрифт по-умолчанию.

SetPen(Width, Color) - Устанавливает параметры "ручки" - толщину и цвет. Если любой параметр опустить, соответствующее значение не будет изменено.

SetBrush(Color, Style) - Устанавливает параметры заливки - цвет и стиль. Если любой параметр опустить, соответствующее значение не будет изменено. Стили заливки: 0 - сплошная, 1 - отсутствует (прозрачная), 2-7 - различные виды штриховки (горизонтальные, вертикальные, в клеточку и т.д.).

TextHeight(s) – Возвращает высоту текста s в пикселях без учета многострочности, с учетом текущего шрифта.

TextWidth(s) – Возвращает ширину текста s в пикселях без учета многострочности, с учетом текущего шрифта.

Использование шрифта (Font): У объекта TCanvas есть «глобальные» установки шрифта. Однако для некоторых функций возможно указание шрифта, отличающегося от глобального. Параметры шрифта – это текстовая строка, состоящая из 6-ти параметров, разделенных запятыми: Название, размер, жирный, курсив, подчеркнутый, цвет. Например:

'Times New Roman, 8, Y, N, N, 255'

Любой параметр можно опустить, и тогда вместо него будет использовано значение по-умолчанию: шрифт: arial, размер – 10, не жирный, не курсив, не подчеркнутый, цвет – черный. Например: ', 7' – указывает, что по-умолчанию нужно взять все параметры кроме размера шрифта. Также можно вместо всей строки указать тире ('-') или пустую строку, и шрифт будет использоваться «глобальный».

Объект можно создать отдельно, не создавая объект TPrinter. В таком случае объект создастся как ссылка на текущий холст принтера (принтер должен быть запущен и начат новый документ). Такой подход используется в доп. возможности PrintCustomSticker

== Объект TPicture ==

Предоставляет функции для работы с графическими изображениями форматов BMP, GIF, JPEG и PNG, а также для формирования штрих-кодов. Обратите внимание, прозрачность изображений не поддерживается, однако в методе TCanvas.DrawPic есть параметр Mode, призванный создавать эффект прозрачности.

Функции:

LoadFromFile(FileName) – Загружает изображение из файла FileName. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromDB(DB, Query) – Загружает изображение из базы данных. DB – ссылка на подключение к базе данных TADO.Self, Query – текст запроса. Запрос должен вернуть в первом поле первой строки BLOB-поле с изображением, все остальные данные возвращаемые запросом игнорируются. Возвращает истину, если операция прошла успешно, иначе – ложь.

LoadFromStr($s) – Загружает изображение из строки $s. Возвращает истину, если операция прошла успешно, иначе – ложь.

CreateBar(Width, Height, BarCode, Textless, Type) – Формирует штрих-код шириной Width и высотой Height с типом кодирования Type. BarCode – текст штрих-кода. Булево значение Textless указывает, что в штрих-коде не должно быть человеко-читаемых символов если истинно. Type указывает тип кодирования: 0 (по-умолчанию) CODE128, 1 - EAN-13, 2 - Interleaved 2-5, 3-DataMatrix, 4-QRCode.
Штрихкод должен быть: Для EAN-13 цифровым 12 или 13 символов (13-й, контрольная сумма рассчитывается автоматически), для CODE128 - должен иметь состоять из допустимого для этого кодирования набора символов. Для Interleaved - должен состоять из четного числа цифр, контрольная сумма автоматически не рассчитывается. Если для Interleaved кода указано значение из 14-ти знаков, подпись цифр выводится в формате Почты России.
Внимание! Для кодов EAN-13 и Interleaved ширина штрих-кода Width не является точным значением получаемого на выходе изображения. Ширина изображения рассчитывается как максимальное кратное минимально возможной ширине, но не меньше минимально возможной. Конечную ширину можно получить в соответствующем свойстве объекта. Для кода CODE128 штрих-код на выходе может оказаться пустым, если указанной ширины штрих-кода не достаточно для его формирования.
Функция возвращает 1 в случае успеха, или текст ошибки, если такая произошла.

SetSize(Width, Height) - Устанавливает размер изображения.

AsString([ImageFormat]) - Возвращает изображение в виде строки с двоичными данными. ImageFormat принимает значения 1 - Bitmap (по-умолчанию), 2 - jpeg, 3 - png, 4 - gif.

Width – Возвращает ширину изображения.

Height – Возвращает высоту изображения.

Rotate(Angle) – Поворачивает изображение по часовой стрелке на угол Angle. Угол указывается в градусах и может принимать любые значения.

Self – Ссылка на объект с изображением, используется в качестве параметра для функций, работающих с изображениями из данного объекта.

Canvas - ссылка на объект TCanvas холста изображения.

== Объект TTable ==

Предоставляет функции для работы с таблицами. Удобен для печати таблицы на принтере. Алгоритм таков: Загружаем датасет в таблицу, настраиваем ее (шрифты, штрих-коды и т.д.), потом выводим на принтер функцией TPrinter.PrintTable.

Функции:

LoadFromDB(DB) – Загружает таблицу из набора данных, открытого в объекте DB типа TADO. Таблица загружается вместе с заголовками. Если название поля содержит подстроку «_RecNo» - данная подстрока не попадет в заголовок, а все значения поля будут заменены на порядковый номер записи в наборе данных, начиная с «1». В одной таблице допускается не более одного поля с порядковой нумерацией. Поля, названия которых начинаются в символа "-" не выгружаются. Заголовок – это первая строка таблицы.

Cell(С, R) – Возвращает значение ячейки таблицы с координатами (C, R). Нумерация строк и столбцов начинается с 1.

SetCell(С, R, Value) – Устанавливает значение ячейки таблицы с координатами (C, R) в Value. Нумерация строк и столбцов начинается с 1.

RowCount – Возвращает количество строк в таблице.

ColCount – Возвращает количество столбцов в таблице.

SetTitleFont(Font) – Задает шрифт заголовка таблицы (первой строки).

SetFont(Font) – Задает шрифт всей таблицы кроме заголовка.

SetColFont(C, Font) - Устанавливает шрифт столбца C.

SetIndent(Indent) – Задает отступ от границы ячейки до текста в процентах от ширины страницы. По-умолчанию значение 0.3

SetWidth(С, Width) – Задает значение ширины столбца C в процентах от ширины страницы.

SetMinRowHeght (Heght) – Задает значение минимальной высоты строки в пикселях.

SetBarCode(Col, Type) - Указывает, что данные из столбца Col должны печататься в виде штрих-кода. Тип штрих-кода - Type. Значение '''"1" - EAN13'''. Для кода EAN13 первая строка данных в ячейке должна иметь вид "тип штрих-кода, номер", например "7, 123" (без кавычек, конечно). В этом случае система сформирует штрих-код: "2700000001233". Первая цифра - всегда 2, далее - указанный тип штрих-кода, нули, чтобы получилось 13 символов, номер, указанный в таблице, и один символ - контрольная сумма. Значение '''"2" - CODE128''' (с версии 734). Данные из первой строки ячейки таблицы печатаются в штрих-коде "как есть". Для всех видов штрих-кода (с версии 734) последующие строки печатаются под штрих-кодом в виде текста.

SetMultiHeader(Active) - Включает печать заголовка при переносе таблицы на несколько страниц. По умолчанию отключено.

SetCustomHeader(script) - Включает печать пользовательского заголовка. Script - это код интерпретатора, который должен печатать заголовок на канву. Печать таблицы может происходить на нескольких листах, по этому скрипт будет вызван для каждого листа. При использовании этого метода, автоматически инициализируются переменные: $TablePageNo - номер страницы, нумерация начинается с нуля; $TableY - координата по оси Y, от которой рисуется заголовок. Чтобы таблица была под заголовком необходимо значение переменной $TableY увеличить на высоту заголовка.

Self – Ссылка на объект с таблицей, используется в качестве параметра для функций, работающих с таблицами из данного объекта.

Пример:
<?>
NEW('TPrinter', 'Prn');
If(prn.ShowDialog,
NEW('TTable', 'Tbl');
NEW('TSelfADO', 'MyDB');
MyDB.Open('SELECT concat("7", ", ", a.code, "\r\n", a.client_id, "\r\n", a.zakaz, "-", a.number) as "Штрих-код", a.target AS "Заказик", address, phone, vlog, poruch FROM address a order by code desc limit 10');
Tbl.LoadFromDB(MyDB.Self);
Tbl.SetBarcode(1, 1);
Tbl.SetCustomHeader(
if($TablePageNo>0,
Prn.Canvas.TextOut(Prn.Canvas.DPIX*0.1, $TableY, 'Продолжение таблицы');
set($TableY, $TableY + Prn.Canvas.TextHeight('H'));
,0)
);
Prn.BeginDoc;
Prn.PrintTable(0, Tbl.Self);
Prn.EndDoc
, );

== Объект TBaseUtils ==

Предоставляет функции, базирующиеся на БД системы «Курьерская служба 2008». По-умолчанию, при создании подключается к основной базе данных модуля, в котором выполняется скрипт, если такая определена контекстом, однако это можно изменить, см SetConnection.

Функции:

'''MakeAddress(s[,town])''' – возвращает значение, полученное путем преобразований адреса s для приведения его к внутреннему формату программы. В процессе преобразования до нескольких раз происходит замена буквосочетаний по таблице замены (ее редактирование доступно по нажатию кнопки «Автозамена» в интерфейсе импорта БД из Excel системы (см. Руководство пользователя)), поиск улиц по базе КЛАДР с точностью до одного знака, и некоторые другие операции, нацеленные на исправление ошибок в написании адреса.

С версии программы 2008.0.0.615, при вызове функции в формулах загрузки реестра, в первую очередь происходит проверка строки s на условия:
* в строке s записано число;
* строка s начинается с "ПВЗ ".
Если одно из этих условий выполняется, то функция пытается установить пункт самовывоза - т.е она сама в загружаемой карточке корреспонденции укажет: адрес ПВЗ, город ПВЗ и установит галку самовывоз. <br/>Правила поиска ПВЗ:
* Если s число - считаем его внутренним кодом филиала;
* Если s начинается с "ПВЗ " - Например в адресе передана строка "ПВЗ На Ленинском проспекте", то искать будем филиал с названием "На Ленинском проспекте" который подчиненный, активный, с галкой ПВЗ и в городе town. Если город не указан, то ищем филиал во всех городах, и считаем его найденным если найдем только один филиал.
* Если филиалы найти не удалось, функция makeaddress работает как обычно и выполняет преобразование адреса.

Если адрес не содержит русских букв, только латиница, и курьерская служба находится в одной из стран Россия, Белоруссия, Казахстан или Украина, и город-получатель (второй параметр, town) находится так же в одной из этих стран, функция автоматически делает транслитерацию адреса на русский язык.

''SetConnection(DB) – Подключает объект к базе данных DB, где DB – ссылка на объект TADO.Self.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

''SetTown(Town) – Устанавливает код текущего города (используется в некоторых функциях объекта) в значение Town. По-умолчанию текущий город – 1.'' '''ВРЕМЕННО НЕ РАБОТАЕТ!'''

'''SetIndexLength(Length)''' – Устанавливает длину почтового индекса. По-умолчанию – 6.

'''GetIndex(Address)''' – Возвращает почтовый индекс из адреса.

'''GetStreet(Address)''' - Возвращает улицу до первой запятой.

'''GetHome(Address)''' - Возвращает номер дома до второй запятой, но не более пяти символов.

'''GetKurierByStation(station, Mass, Cash, Date_Putn)'''

'''TownByIndex(Index[, PriorityName][, PriorityCountry])''' – Возвращает код города по индексу. В случае ошибки поиска – код текущего города. Если нашлось несколько населенных пунктов, и указано приоритетное название - выбирается населенный пункт, название которого начинается с PriorityName (если есть).

'''TownByName(Name[,NotNeedCL=False, City=0])''' – Возвращает код города по имени. В случае ошибки поиска – возвратит код текущего города. Если параметр NotNeedCL (параметр не обязательный) установить в TRUE, тогда функция возвратит 0, если город не удалось найти. Параметр City (код региона) позволяет ограничить поиск одной областью (не обязательный, по умолчанию не используется).

'''FillClientInfo(Excel, client, Sheet, Row, Col)''' – Выводит в эксель информацию о клиенте с кодом client на лист sheet начиная со строки row и столбца col.

'''SavePrintFormToFile(FormType, FormNumber)''' - Сохраняет на диске файл печатной формы и возвращает путь к нему

'''CreateTrans(Address[, Store][, Operator])''' - Формирует запись для печати кассового чека для корреспонденции с кодом Address, для выбора кассового аппарата используется код склада Store. Если Store не указано - при исполнении в среде клиентского модуля системы использует склад, указанный пользователем в окне [[Настройка параметров рабочего места|"Настройка" - "Параметры"]], в остальных модулях - код текущего склада из [[Настройка глобальных параметров|переменной]] "CL" ("Текущий филиал"). Поле Operator позволяет указать кассира (передается код справочника сотрудников). Если не указан, в основной системе будет использован код авторизованного пользователя, в других модулях - 1. Возвращает идентификаторы записей чеков. Может вернуть пустую строку, если чек создавать не понадобилось, один или несколько кодов через запятую, если создано несколько чеков. В случае ошибки вызывает ошибку, поэтому рекомендуется использовать с функцией Try.

'''CreateReturnTrans(Address)''' - формирует запись для печати чека возврата для корреспонденции с кодом Address. Чек возврата печатается на полную сумму и с теми же атрибутами, что и чек продажи. Возвращает идентификатор записи чека возврата. В случае ошибки вызывает ошибку, поэтому, как и с CreateTrans, рекомендуется использовать с функцией Try.

'''CalcTownDeliveryDays(Source, Mode, TownTo, TownFrom)''' - возвращает количество дней необходимых на доставку отправления, только для межгорода. Source - код клиента, Mode - режим срочности, TownFrom - код города отправителя, TownTo - код города получателя.

'''CalcDeliveryDate(Source, Mode, TownTo, TownFrom, Date_Beg, Time_beg)''' - Возвращает планируемую дату доставки с учетом сроков доставки. Работает при городской и междугородней доставке. Для межгорода сроки доставки берутся из зон. Для городской доставки, из дополнительных параметров статуса (17 статус, 1 параметр в доп. информации) Если рассчитать дату планируемой доставки не удалось, возвращает пустую строку. Параметры: Source - код клиента, Mode - режим срочности, TownTo - город получатель, TownFrom - город отправитель, date_beg - дата заказа (может быть передана строкой в формате DD.MM.YYYY или в числовом), time_beg - время заказа.

'''GenSpecialSMA(DirectExcel, Code)''' - функция для генерации отчета о доставке по акту передачи денег. Первый параметр - указатель на TDirectExcel, второй параметр - код акта передачи денег. АПД выводится на текущий лист объекта TDirectExcel.

'''CreateSpecialSMA(ClientCode, DateTo)''' - Функция создает исходящий акт передачи денег (АПД). Требует ClientCode - код клиента, DateTo - дату акта. Функция возвращает коды созданных актов. Если возвращаемых параметров два, значит функция пыталась создать два АПД: первым, идет код АПД с наличной оплатой, а вторым с безналичной. Примеры возвращаемого результата: '0'- акт не был создан, отсутствуют корреспонденции; '124' - код созданного акта; '0,0' - пытались создать два акта, но отсутствуют данные; '4556,0' - создан только наличный АПД; '0,445' - создан только безнал.; '4556,445' - созданы нал. и безнал.

'''CreateAddressForActDelivery(ActCode, [Delivery_Tomorrow=False, Delivery=True])''' - Функция создает корреспонденцию на доставку акта. ActCode - код акта; Delivery_Tomorrow - установить план. дату доставки следующим рабочим днем или сегодня (по умолчанию , сегодня); Delivery - создать корр. на доставку АПД или создать корреспонденцию на забор АПД (по умолчанию, доставка АПД). Возвращает код созданного адреса.

'''CreateAddressTransferAct(ClientCode, Store, DateTo, [AdditionalParam])''' - Функция создает исходящий акт передачи корреспонденции (АПК). Требует ClientCode - код клиента, Store - код филиала, для которого будет создан акт, DateTo - дату, до которой в акт попадут возвраты, AdditionalParam - дополнительный строковый параметр для передачи в системную доп. возможность ExceptionsForAPK, позволяющий отобрать в акт, например, только полные возвраты. Возвращает код созданного акта. ВНИМАНИЕ: при создании АПК используется системная функция ExceptionsForAPK. Если в ней используются интерактивные функции (вывод сообщений, диалоговые окна, выполнение скриптов), то акт сформирован не будет, а функция CREATEADDRESSTRANSFERACT вернет ошибку.

'''GetPolygonByAddress(Address, TownCode, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попал адрес. Если полигон найти не удалось, функция возвратит пустую строку. Address - адрес корреспонденции текстом; TownCode - код города; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByAddress(addressrecord.address, if((addressrecord.number=0)*(addressrecord.strbarcode=<nowiki>''</nowiki>), addressrecord.townfrom, addressrecord.townto), '`schema`=1') - пытаемся найти вхождение адреса в полигоны 1 схемы, при выборе города учитывается корр. на забор, у нее нужно использовать город-отправитель (а для обычной корр. нужен город-получатель).

'''GetPolygonByLatLon(Lat, Lon, where[, field='code'])''' - функция возвращает значение связанное с полигоном в который попали GPS координаты. Если полигон найти не удалось, функция возвратит пустую строку. Lat - широта текстом; Lon - долгота текстом; where - SQL условие; field - необязательный параметр, определяет возвращаемое значение при найденном полигоне, по умолчанию равен "code".

Пример:
GetPolygonByLatLon('55.769064','37.590713','zone is not null and price=0') - пытаемся найти вхождение координат в полигоны, где задана зона, для всех клиентских и курьерских зон.

'''GetLatLonByAddress(AddressText, TownCode)''' - возвращает географические координаты вида lat,lon указанного в AddressText адреса. Поиск производится в городе, имеющем код TownCode в таблице Town.

'''CalcAgentPrice(AddressCode, AgentCode, TownFrom, TownTo, Mode, [, Count=1])''' - функция возвращает стоимость доставки рассчитанную по тарифу агента. AddressCode - код адреса, AgenCode - код филиала (агента), TownFrom - код города отправителя, TownTo - код города получателя, Mode - режим срочности, count - тарифная сетку от указанного количества отправлений (по умолчанию 1)

'''SetAddrKol_vo(address, getkol_vo)''' - функция делает прием корреспонденции в текущем ответственном филиале. address - внутренний код адреса, getkol_vo - количество принимаемых мест, может принимать значения: "kol_vo" - принять все места, "getKol_vo+1" - принять еще одно место, "число" - сделать количество принятых мест равным указанному числу.

'''GetBasePrice''' - возвращает базовую стоимость доставки посчитанную по тарифной сетке клиента в зависимости от :кол-ва заказов,зоны,типа,срочности,массы, расстояния. В системах с выключенными доп. услугами также считает проценты от суммы и страховки.
Описание параметров:

*ds - ссылка на объект датасета с основными параметрами расчета цены. Значение по умолчанию доступно в формулах тарифа и доп. услуг, через вызов "dataset._self".
Описание некоторых полей датасета:
pmoney - процент от суммы;
pmoneycard - процент от суммы при оплате картой;
pricecode - код прайса (таблица Price) ;
distarea - район метро получателя (актуально при отключённом едином районировании, как правило район от 200 до 299 является признаком области);
region - признак области при включенном едином районировании;
distareaFrom и regionFrom - аналог distarea, region только для отправителя;
pcncode - код записи таблицы pricecnt "количество от";
Запрос содержит поля таблицы pricelinesnew - начальная стоимость по тарифной сетки, найденные без учета массы,только по типу срочности и режиму.
Запрос содержит поля таблицы price.

*addressrecord - ссылка на объектную модель карточки корреспонденции, следует использовать уже созданную addressrecord._self
*count - количество корреспонденций от клиента. (может показывать кол-во корреспонденции в текущем заказе или за прошлый месяц, в зависимости от выбранной схемы подсчета заказов в тарифе)
*type - тип корреспонденции;
*mode - режим доставки;
*wait - количество минут ожидания (не учитывается при доп. услугах, есть системная услуга "ожидание");
*mass - масса отправления;
*rur - сумма передаваемых денег (не учитывается при доп. услугах, есть системная услуга "процент от суммы");
*inshprice - сумма страховки (не учитывается при доп. услугах, есть системная услуга "процент от объявленной стоимости");
*distance - расстояние до места доставки, обычно поле заполняется при доставке в область (регион в едино районировании). Дополнительная наценка к стоимости доставки;
*forward - направление доставки: true - туда; false - обратно;
*Collection - признак заборной корреспонденции: true - забор, false - доставка (В тарифе есть возможность указать стоимость для забора);
*TownFrom - код города отправителя;
*TownTo - код города получателя.

В тарифе есть возможность указать формулу, которая может влиять на базовый расчет. Формула может объявить служебные переменные, которые:
*$FormulaReplace - если true – возвращаемое значение полностью заменяет базовый расчет;
*$FormulaKoeff - коэффициент на который будет помножена базовая стоимость.
Также внутри формулы объявлены следующие объекты dataset, addressrecord и переменные:
*$ForceIntown - Переменная становится истиной, если междугородний расчет был отменен, т.к. адрес попал в нарисованную зону на карте.
*а также: $forward, $distance, $Count, $Collection, $Wait, $FormulaKoeff, $PriceCode - описание есть выше.

Для направления "туда", Функция GetBasePrice вызывается через доп. услугу "База" (при включенных доп. услугах), для направления "Обратно" всегда вызывается напрямую (т.к. доп. услуги работают только в для направления "туда").
На расчет этой функции влияют следующие переменные: "Финансы" -> "Расчет стоимости по адресу", "Финансы" -> "Зона клиента по умолчанию", "Финансы" -> "Подсчет кол-ва отправлений за месяц".

'''CalcAddressPrice(AddressCode, [,ZakazCount])''' - полностью пересчитывает стоимость доставки корреспонденции по тарифу клиента. AddressCode - внутренний код адреса, ZakazCount - не обязательный параметр, кол-во заказов от клиента.

'''GetStationCode(s [,town])''' – возвращает код станции метро, ассоциированный в системе с адресом s. В случае невозможности идентифицировать станцию метро – возвращает 0.
Когда включено районирование по карте, необходим второй параметр "town" - код города в котором нужно искать адрес. Возвращает код района если удалось его найти; код станции меж-города - если адрес удалось геокодировать, но район не нашли; код 0 - когда не удалось геокодировать адрес.

'''RecalcSpecialSMA(ActCode)''' - пересчитать акт передачи денег (АПД). Также, у корреспонденций входящих в АПД будет пересчитана стоимость доставки. Для Входящего АПД сумма акта не пересчитывается. Параметр ActCode - внутренний код акта, коды можно перечислять через запятую.

'''UserCode''' - Возвращает код текущего пользователя из таблицы «Пользователи» (users).

'''UserName''' - Возвращает имя текущего пользователя из таблицы «Пользователи» (users).

'''UserPass''' - Возвращает пароль текущего пользователя.

'''UserBaseCode''' – Возвращает код текущего пользователя из таблицы «Сотрудники» (kurier).

'''UserEmail''' - Возвращает e-mail текущего пользователя.

'''CurrentTown''' – Возвращает код текущего города (из таблицы town).

'''CurrentCity''' – Возвращает код текущего региона (из таблицы city).

'''CurrentLocation''' – Возвращает код текущего филиала (из таблицы store).

'''FillExcelDoc'''(Excel, Dataset, FormType, FormNumber) - Выполняет указанную печатную форму в объекте excel. Dataset объект с данными для скрипта в печатной форме, может быть null. Dataset передавать можно так db.self, тогда переданный dataset внутри печатной формы будет доступен по имени dataset. Например:

new('TExcel', 'excel');
FillExcelDoc(excel.self, null, 12, 1);
excel.DoNotDestroy(true);
excel.SetVisible(true);
''Покажет эксель с выполненной печатной формой''

'''ValutaSign''' – Возвращает название валюты для суммы.

'''SendToMeasoft(xml)''' - Отправляет запрос в клиентское API Measoft. Автоматически добавляет начальный "<?xml version="1.0" encoding="utf-8"?>".

'''InsertFirmAtt(excel, sheet, firmcode)''' - Вставляем на лист эксель по коду фирмы: печать, подпись, подпись бухгалтера, логотип. Тэги <STAMP>, <DIR>, <BUH>, <LOGO> соответственно. После тега можно указать размеры изображения в символах Microsoft Excel. Формат записи: <STAMP> 16, 16

'''PreCalcSalary(kurier, addressCodes)''' - Рассчитывает предварительную зарплату. Kurier - код курьера, используется для определения тарифа. addressCodes - коды адресов, через запятую для которых необходимо посчитать зарплату. Результаты расчета будут записаны в таблицу kurierpaydetail, так как расчет предварительный то записи не будут прикреплены к конкретному начислению.

select a.code, kpd.price as "туда", kpd2.price as "обратно" from address a
left join kurierpaydetail kpd on kpd.sourcetable=3 and kpd.sourcecode=a.code and kpd.rectype = 1
left join kurierpaydetail kpd2 on kpd2.sourcetable=3 and kpd2.sourcecode=a.code and kpd2.rectype = 2
where a.code in (...)

'''CalcSalary(DateTo, [Filter=0, KurierCode = 0, ManagerCode = 0])''' - Полный расчет зарплаты курьерам. DateTo - дата до которой создается начисление. Условия отбора курьеров для начисления. Filter - роль сотрудника: 0 - Все, 1 - курьеры, 2 - менеджеры; KurierCode - код курьера, ограничить расчет зарплаты одним курьером;ManagerCode - код курьера, ограничить расчет зарплаты курьерами указанного менеджера. Внимание фильтры Filter, KurierCode и ManagerCode накладываются друг на друга. Результатом функции является SubSQL с информацией по созданным начислениям.
поля ответа: код курьера, код менеджера, начислено, бонусы, штрафы, аванс, итого;
select kurier, manager, profit, bonus, shtraf, prepay, total [union select ...]

== Объект TINIFile ==

Предоставляет функции работы с ini-файлами. В некоторых контекстах создается автоматически для предоставления доступа к настроечному файлу модуля, выполняющего скрипт.

Функции:

IniParam(s[,section='common']) – Существует только если имя экземпляра объекта пустое. Возвращает значение параметра s ini-файла секции «common», изменить секцию можно не обязательным параметром section. В случае отсутствия параметра в файле возвращает пустую строку.

Param(s) – Синоним IniParam с тем отличием, что существует только если имя объекта непустое.

SetText(s) - Загружает ini файл из строки s. Если в файле нет секции «common», то принудительно объявляет ее в начале.

== Объект TSMS ==

Предназначен для отправки SMS, а также проверки статуса их доставки.

Функции:

SetProxy(Server, Port, User, Pass) - Устанавливает настройки прокси-сервера.

Connect(Provider, Host, User, Pass, SenderName, SMSPrefix) – Подключает объект к провайдеру provider, используя адрес Host, имя пользователя User и пароль Pass. Значение SMSPrefix предназначено для того, чтобы провайдер мог различить сообщения от разных филиалов, если этими филиалами используется одно подключение. Если необходимости разделять сообщения нет - значение SMSPrefix можно не указывать.
Для провайдера доступны значения 'mirsms', 'sms16', 'websms', 'epochta', 'zanzara', 'SMSManager', 'f1sms', 'BitCall', 'mirsmsGET', 'AMD' и другие, либо можно указать числовые значения номера протокола, от 1 до <rspoiler text="20">Набор провайдеров все время дополняется, количество и номера можно смотреть в Справочники - Переменные - Подключения - SMS</rspoiler> соответственно. Эти значения соответствуют значениям переменной SMSProtocol таблицы "Value".

SendSMS(Phone, Text, [ID]) – Отправляет SMS с текстом Text на телефон Phone. Для некоторых провайдеров необходим уникальный идентификатор сообщения ID. Возвращает ID провайдера для последующей проверки статуса доставки.

CheckSMS(ProviderID) – Проверяет состояние доставки сообщения с идентификатором ProviderID. Возвращает: 0 – доставляется, 1 – успешно доставлено, 2 – не доставлено.

ReceiveSMS(InboxID, DateFrom, DateTo, NewOnly) - Получает входящие SMS, с ящика InboxID (идентификатор выдаётся провайдером). DateFrom, DateTo - задается временной интервал в котором были приняты сообщения(формат 08.04.2013 18:00:00 'DD.MM.YYYY HH:NN:SS'). Чтобы получать только новые сообщение поле NewOnly должно быть True. Возвращает XML с сообщениями.

ExtraResult([ParamName='']) - Вызывается после CheckSMS, возвращает дополнительную информацию по последнему статусу смс. В настоящее время работает только для провайдера BitCall, по умолчанию возвращает кнопки, нажатые абонентом во время работы с голосовым меню. Если в paramname указать 'IdentifyText' то будет возвращен JSON с ответами абонента на заданные вопросы(используется в случае звонков с индивидуальным сценарием).

Log - Возвращает последний HTTP запрос и ответ от сервера смс.

== Объект TXML ==

Предназачен для парсинга XML-данных.

Функции:

SetText(S) – Задает текст XML документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию. Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

AttribCount – Возвращает количество атрибутов текущего элемента.

AttribName(i) – Возвращает имя атрибута с номером i.

Attrib(V) – Ищет атрибут и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию.

Reset – Делает текущим корневой элемент, возвращает его значение.

== Объект TJSON ==

Предназачен для парсинга JSON-данных.

Функции:

SetText(S) – Задает текст JSON документа для парсинга, делает текущим корневой элемент.

NodeValue – Возвращает значение текущего элемента.

NodeName – Возвращает имя текущего элемента.

OpenChild(V) – Ищет дочерний элемент и делает его текущим. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Возвращает значение найденного элемента, или пустую строку, если элемент не найден. Нумерация элементов начинается с нуля.

ChildrenCount – Возвращает количество дочерних элементов.

ChildNodeValue(V) – Ищет дочерний элемент и возвращает его значение. Если V – число – ищет по номеру, если V – текст – ищет по названию (регистрозависимый поиск). Можно проверять наличие элементов, если элемента нет, вернется пустая строка.

OpenParent – Делает текущим родительский элемент. Возвращает значение найденного элемента.

Reset – Делает текущим корневой элемент, возвращает его значение.

isArray - Возвращает true, если текущий элемент является массивом (доступ к дочерним элементам возможен только по индексу, нумерация элементов начинается с нуля)

==Объект TZip==
Предназначен для работы с Zip архивом.

SetZip(s) - Загружает архив в объект из строки s;

GetZip - Возвращает архив в виде строки;

AddFromFile(SrcPath, ZipPath) - Добавляет файл SrcPath в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

AddFromStr(Data, ZipPath) - Добавляет файл из строки Data в архив и располагает его по пути ZipPath. ZipPath содержит имя файла в архиве, при необходимости можно указать каталог;

LoadFromFile(path) - Загружает архив из файла path;

SaveToFile(path) - Сохраняет архив в файл path;

Count - Возвращает кол-во файлов в архиве;

DataByIndex(index) - Возвращает распакованный файл в виде строки. Index - номер файла в архиве;

DataByName(ZipPath) - Возвращает распакованный файл в виде строки. ZipPath - путь к файлу в архиве, может содержать каталоги;

FileName(index) - По номеру файла, функция возвращает полный путь файла в архиве.

==Объект TBase==

Функции общего назначения:

execsimplescript(Caption, Text) - Выполняет скрипт "Дополнительных возможностей". Возвращаемые значения, введенные пользователем устанавливает в переменные $scriptvar1..$scriptvarN, Значения кодов списочных переменных - в переменных $scriptvar1codes..$scriptvarNcodes. Функция возвращает истину, если пользователь нажал "OK" в диалоговом окне.

FillAdvPriceReport(Excel, AddressCodes, StartLine, StartCol, [ShowSumPrice,InsertColumns]) - добавляет отчёт по дополнительным услугам. В AddressCodes - указаны коды адресов через запятую, каждый код это отдельная строка отчета. Адреса будут показаны в порядке перечисления их в AddressCodes. Если в отчет нужно добавить пустую строку, то можно указать код адреса -1000. StartLine, StartCol - верхний левый угол выгружаемой таблицы. ShowSumPrice - добавить столбец итоговый столбец с суммой всех услуг, по умолчанию выключено. InsertColumns - раздвинуть таблицу перед вставкой отчета, позволяет встраивать отчет посередине выгрузки, по умолчанию выключено. Функция возвращает количество использованных столбцов.

PrintSticker(Codes, [ToBoxes=False])

GetItemByName(Name)

GetA4Printer - возвращает имя принтера выбранного для печати документов

GetStickerPrinter - возвращает имя принтера выбранного для печати стикеров

'''Функции, работающие только в импорте БД из эксель:'''

ReplaceAddress

GetItemByCode - Поиск товара по артикулу. Внимание: в пределах одного клиента может быть несколько товаров с одинаковыми артикулами. В этом случае функция найдет последний заведенный товар.

GetPrice

GetNewNumber - используется при импорте реестра, возвращает номер конверта в загружаемом заказе

GetNewPos - используется при импорте реестра, возвращает порядковый номер вложения

GetNewPackagePos- используется при импорте реестра, возвращает порядковый номер места

Zakaz - возвращает номер заказа куда происходит импорт реестра

addresscode - используется при импорте реестра, код созданного адреса

Source - код заказчика

'''ClientTown''' - Узнаем город клиента, через филиал с которым он работает. Сам клиент берется из заказа указанного в окне "Импорт БД из Excel".

== Объект TFieldObject ==
Объект для доступа к записям, используется в картах и доп.услугах.

_GETTABLEINFO - возвращает данные о полях и примеры данных объекта.

== Применение языка формул ==
'''в различных контекстах системы «Курьерская служба 2008» и сопутствующих проектах'''

=== Курьерская служба 2008 ===

==== Дополнительная информация на чеке ====

В карточке клиента на закладке «Касса» имеется поле для ввода текста, который будет отображаться на кассовых чеках, печатаемых для корреспонденции от данного клиента. В поле может быть введен как просто текст, так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TSelfDB с открытым набором данных со строчкой корреспонденции, заказа и клиента, на которую печатается чек

TBaseSupport

TBaseValue

Все объекты создаются с пустыми именами.

Так же система записывает в переменную $CashRegisterID вычисленный код фискального регистратора, на котором предполагается печать чека.

Результат работы скрипта печатается на создаваемом чеке, если скрипт не возвращает значение “-1” (число или текст) – в этом случае система чек не создает. Подразумевается, что либо скриптом было принято решение об отсутствии необходимости формирования чека, либо скрипт взял эту функцию на себя.

==== Заполнение шаблонов печатных форм ====

==== Дополнительные возможности ====

==== Импорт БД из Excel ====
В окружении интерпретатора создается объект ZakazRecord, он является списком со значениями таблицы zakaz. Именно в этот заказ будут загружены данные. Из этого объекта также доступно :<br>
*ZakazRecord.userfields - пользовательские поля заказа;
*ZakazRecord.Clients - данные таблицы clients;
*ZakazRecord.Clients.userfields - пользовательские поля заказчика.

==== Прайс лист клиента ====

Формула возвращает сумму в валюте клиента для каждой поездки (туда или обратно) единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Помимо стандартных объектов, система создает объект AddressRecord, в котором, как свойства, доступны все поля текущей записи. Так же она выставляет значение переменной $Forward в 1 (истина), если необходимо произвести расчет для направления "Туда" и 0 (ложь) - если обратно. ВНИМАНИЕ! Как и во всех остальных местах, после формулы нельзя ставить ";", иначе скрипт вернет 0!

Например:

if(int(AddressRecord.Time_Put_Max)>19, 100, 0)

''Прибавляет 100 рублей в случае, если максимальный срок доставки 20 часов или более''

if(pos(AddressRecord.Address, 'Аренда')>0,
set($FormulaReplace, 1);
1500
, 0)

''В случае наличия подстроки "Аренда" в адресе заменяет штатное ценообразование на 1500 рублей''

Объект AddressRecord может предоставить доступ к связанным таблицам :
* addressrecord.boxes
* addressrecord.packages
* addressrecord.clients
* addressrecord.price
* addressrecord.advprice
* addressrecord.userfields
* addressrecord.addressfld
* addressrecord.clients.userfields
* addressrecord.price.userfields
* addressrecord.zakaz
* addressrecord.zakaz.userfields

Чтобы получить доступ к полю VarCode из таблицы userfields необходимо записать AddressRecord.Userfields.VarCode. В присоединённой таблице может быть несколько записей чтобы получить к ним доступ предусмотрены функции _First, _EOF, _Next, _RecordCount, _Set.

Пример:
set($value1, 0); set($value2, 0);
while(AddressRecord.userfields._EOF=0,
if(AddressRecord.userfields.varCode=1,
set($value1, if(AddressRecord.userFields.VarValue='Праздничная упаковка', 150, 0)), ''''''');
if(AddressRecord.userfields.varCode=2,
set($value2, AddressRecord.userFields.VarValue), ''''''');
AddressRecord.userFields._Next;
);
int($value1) + int($value2)

Пример делающий тоже самое что и выше но через поиск Locate:
set($value1, if(addressrecord.userfields.VarValue('VarCode', 1)='Праздничная упаковка', 150, 0));
set($value2, int(addressrecord.userfields.VarValue('VarCode', 2)));
$value1 + $value2

В скрипте доступны переменные:
«$FormulaKoeff» - это коэффициент на который умножится конечная цена (по умолчанию равна 1);
«$PriceCode» - код прайса;
«$CurrentPriceConf» - код услуги;
«$BasePrice» - стоимость всех услуг с взведённой галкой "+ к Базовой".

Для вызова функции CalcBasePrice (Расчёт базовой цены) в скрипте объявленны переменные: $Count,$Collection,$Distance,$Wait.

Существует поиск по ключевому полю (поиск регистронезависимый), например чтобы найти в таблице advprice введённое значение для текущей услуги, нужно сделать такую запись addressrecord.advprice.value('priceconf', $CurrentPriceConf) - Первый параметр это ключевое поле, второй искомое значение. Если запись найдётся будет возвращено значение поле value, если нет функция вернёт значение 0.

Пример
if(addressrecord.advprice.active('priceconf', 3)='T', addressrecord.advprice.price, 0)

''Смотрим включена ли услуга и если да, возвращаем рассчитанную стоимость

Чтобы изменить значение записанное в объект addressrecord, нужно воспользоваться методом _set(keyfield, keyvalue, filed, value). Параметр keyfield - ключевое поле, keyvalue - искомое значение, filed - имя столбца, value - новое значение столбца. Сначала происходит поиск строки по ключу, далее меняется значение указанного столбца.
Пример, отключение услуги база:
addressrecord.advprice._Set('priceconf', 1, 'active', 'F')
priceconf - поле где записан код услуги;
1 - услуга База;
active - поле показывающее включение услуги.

Также существует упрощенный метод _set, с двумя параметрами filed, value - он используется в шаблонах загрузки или в системных доп. возможностях где доступен объект addressrecord.

==== Зарплата курьеров ====

Формула возвращает сумму в основной валюте для каждой единицы корреспонденции, которая добавляется к штатному ценообразованию. Если формула установила в значение «Истина» переменную «$FormulaReplace», то значение, возвращаемое формулой заменяет штатное ценообразование. Переменные «$FormulaTablKoeff» и «$FormulaMoneyKoeff» позволяют установить повышающий или понижающий коэффициент на стоимость доставки (по тарифной сетке) и услуги соответственно (процент от суммы, процент от стоимости доставки, ожидание). Переменная «$UsingZoneName» и «$KurierZone» содержат название и код зоны соответственно, есть возможность поменять название зоны для отчета.

=== Планировщик ===

В поле текста задания может быть введен как текст с командами планировщика (см ниже), так и интерпретируемый скрипт, начинающийся с признака скрипта: «<?>». В контексте выполнения скрипта система создает объекты:

TIniFile, Указывает на настроечный ini-файл планировщика.

Все объекты создаются с пустыми именами.

Для записи в лог планировщика нужно использовать функцию Print

=== Репликатор ===

== Прочее ==
ReplaceAddress(target, address) – Возвращает адрес последней доставки корреспонденции получателю target по адресу address от текущего клиента. При отсутствии такой доставки, возвращает address.

GetPrice –возвращает рассчитанное значение цены, на основе прайс-листа клиента и данных о корреспонденции.

GetKurierByStation(i) – возвращает код курьера, ассоциированного со станцией метро с кодом i.

GetNewNumber – Возвращает не занятый номер единицы корреспонденции в текущем заказе.

==История изменений==

=== Недавние изменения ===

{|
||'''Добавлено:'''
|В объект TExcel добавлен метод ColumnDelete.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция InsertFirmAtt.
|-
||'''Добавлено:'''
||В объект TExcel добавлен метод Align.
|-
||'''Добавлено:'''
|Функция CheckEan
|-
||'''Добавлено:'''
|В объект функцию FillAdvPriceReport добавлены параметры ShowSumPrice,InsertColumns
|-
||'''Добавлено:'''
|В объект TSMS добавлен метод Log.
|-
||'''Добавлено:'''
|Добавлена функция Money.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция ValutaSign.
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция GetPolygonByLatLon.
|-
||'''Добавлено:'''
|В объект TTable добавлена функция SetMultiHeader, SetCustomHeader.
|-
||'''Добавлено:'''
|Функция DownloadAttachment
|-
||'''Добавлено:'''
|В функцию SetRowHeight объекта TExcel добавлен параметр cnt.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция AsString.
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция SetSize.
|-
||'''Добавлено:'''
|В объект TADO добавлена функция ParseForIn.
|-
||'''Изменено:'''
|В объект TBaseUtils из TBase перенесена функция FillExcelDoc.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция CalcAddressPrice
|-
||'''Изменено:'''
|Все функции класса TBaseSupport перенесены в TBaseUtils. Класс TBaseSupport больше не существует.
|-
||'''Добавлено:'''
|В функции RowInsert и RowDelete объекта TExcel добавлен параметр count.
|-
||'''Добавлено:'''
|В объект TBaseUtils функция SendToMeaSoft
|-
||'''Добавлено:'''
|В объект TBaseUtils функция RecalcSpecialSMA
|-
||'''Добавлено:'''
|Новая функция Reverse
|}

=== Версия 849   22.02.2018 ===

{|
||'''Добавлено:'''
|В функцию TBaseUtils.TownByIndex добавлен параметр PriorityName
|-
||'''Добавлено:'''
|В объекте TBase добавлена функция GetNewPackagePos
|-
||'''Добавлено:'''
|В объекте TSMS доработан метод ExtraResult, добавлен параметр ParamName
|-
||'''Добавлено:'''
|В объект TBase добавлена функция CalcAgentPrice
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateAddressForActDelivery
|-
||'''Изменено:'''
|Функция CalcTownDeliveryDate заменена на CalcDeliveryDate
|-
||'''Добавлено:'''
|В объект TBaseUtils добавлена функция CreateSpecialSMA
|-
||'''Добавлено:'''
|Функция SignatureUrl
|-
||'''Добавлено:'''
|В объект TPicture добавлена функция LoadFromStr.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetPen.
|-
||'''Добавлено:'''
|В объект TCanvas добавлена функция SetBrush.
|-
||'''Добавлено:'''
|В объект TPicture добавлена поддержка чтения в формате PNG.
|-
||'''Добавлено:'''
|В функцию TCanvas.DrawPic параметр Mode
|-
||'''Добавлено:'''
|Свойство TPicture.Canvas
|-
||'''Добавлено:'''
|Функция DeleteFile
|}

=== Версия 758   29.03.2017 ===
{|
||'''Добавлено:'''
|Функция GetPolygonByAddress
|-
||'''Добавлено:'''
|Функция ParamsCount
|-
||'''Добавлено:'''
|Объект TZip
|-
||'''Изменено:'''
|Функции CreateEAN и Create128 заменены одной функцией CreateBar, полностью совместимой с Create128, но добавлена поддержка EAN-13 и Interleaved 2-5 (для Почты России). В системе функции оставлены для обратной совместимости, но более не являются документированными и рекомендованными к использованию.
|-
||'''Добавлено:'''
|Параметр text в функцию Cell объекта TExcel
|-
||'''Добавлено:'''
|Функция UrlEncode
|-
||'''Добавлено:'''
|Функция IncDay теперь может принимать параметр count
|-
||'''Добавлено:'''
|Функции FtpGet, FtpPut, TTable.SetCell()
|}

=== Версия 452   26.02.2014 ===

{|
||'''Добавлено:'''
|Функция Time
|-
||'''Добавлено:'''
|Функция FixedIntToStr
|-
||'''Добавлено:'''
|Функция TimePeriod
|-
|'''Добавлено:'''
|В интерпретатор добавлена функция приёма смс - ReceiveSMS
|-
|'''Добавлено:'''
|Функция STR2UTF
|-
|'''Добавлено:'''
|Функция SAVETOFILE
|-
|'''Добавлено:'''
|Функция TExcel.SetSheetName
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "FILESTR"
|-
|'''Добавлено:'''
|Расширены возможности объекта addressrecord в формулах тарифов
|}

=== Версия 308   24.11.2012 ===

{|
|'''Добавлено:'''
|В функции загрузки таблиц из TADO добавлено условие, что поля, названия которых начинаются с "-" не выгружаются. Таким образом можно скрывать служебные поля из результирующего набора.
|-
|'''Добавлено:'''
|Функция TExcel.RowAutoFit
|-
|'''Добавлено:'''
|Функция TExcel.RowInsert
|}

=== Версия 300   01.11.2012 ===

{|
|'''Добавлено:'''
|В объекте TCSVFile добавилась возможность запрашивать значения не только текущей записи через параметр сдвига
|-
|'''Добавлено:'''
|В пользовательские отчеты добавлен тип "UPDOWN"
|-
|'''Добавлено:'''
|В интерпретатор добавлен объект TCSVFile
|}

=== Версия 266   14.09.2012 ===

{|
|'''Добавлено:'''
|В интерпретатор добавлена поддержка массивов
|}

=== Версия 265   11.09.2012 ===

{|
|'''Добавлено:'''
|Функция CreateTrans в интерпретатор
|-

API

2021-09-22T10:30:09Z

Johny: /* Ограничения */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentation|HERE!]]'''
</div>

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

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

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

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

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==

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

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://marketplace.1c-bitrix.ru/solutions/measoft.courier/ Установить] 
|Поддерживает версии 14.5 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше.
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|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_ос3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSales|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/wordpress.zip Скачать]
|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

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

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

[[Файл:extra1.png|750px]]

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

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

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].
* вы должны знать номера заказов, которые вы отправили. Не нужно перебирать номера всех заказов или брутфорсом перебирать все возможные номера.

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

== Оформление заказа ==
=== Пример оформления заказа ===

<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<items>
<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="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<overall_volume>81</overall_volume>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

*'''neworder''' - Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

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

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

*'''sender''' - Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

*'''receiver''' - Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

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

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

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

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

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

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

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

*'''costcode''' - Кост-код сотрудника.

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

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

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

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

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

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</div>
<br />

=== Примеры ответов ===

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickup>NO</pickup>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<costcode>cc12345</costcode>
<receipt 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</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrival>2016-05-02 23:21</arrival>
<outstrbarcode>EXT123456</outstrbarcode>
<return_message>Доставлено в целости</return_message>
<department>Отдел</department>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</statusreq>
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

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

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

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

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

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

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

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

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

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

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
</commitlaststatus>
</source>

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

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

В случае успеха Вы получите ответ
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

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

== Трекинг заказа по номеру ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
</order>
</tracking>
</source>

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
}
]
}</pre>

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

== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* вместо корневого тэга '''neworder''' указывается '''editorder'''
* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.

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

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

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

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

== Добавление вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" size="35654">JVBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg" size="74861">VBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==

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

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

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<items>
<item code="34533" quantity="1" reason="0" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</image>
</order>
</setorderinfo>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==

'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
</waybill>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

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

== Справочник регионов ==

'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>RU</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<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>
</city>
</regionlist>
</source>

== Справочник улиц ==

'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

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

*'''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>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==

'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<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>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

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

== Движение номенклатуры ==

'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</itemmovements>
</itemlist>
</source>

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

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

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

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

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

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

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

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

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Уфа город",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</source>

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

== Номенклатура приходной накладной ==

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

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

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

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

== Справочник филиалов ==

'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

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

== Справочник пунктов самовывоза ==

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

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<city>Свердловская область</city>
<town regioncode="66" country="RU">Нижний Тагил</town>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

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

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

*'''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="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==

'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<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.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==

'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==

'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
<visible>NO</visible>
</advprices>
</source>

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

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

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

== Расчет стоимости доставки ==

'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
<userid>user123</userid>
<groupid>customer</groupid>
</order>
</calculator>
</source>

Параметры:
*'''pricetype''' - тип требуемой цены. Возможные значения: "CUSTOMER" (по-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], "CLIENT" - цена курьерской службы для клиента.
*'''townfrom''' - Город отправления
*'''addressfrom''' - Адрес отправления
*'''zipcode''' - Почтовый индекс города назначения
*'''townto''' - Город назначения
*'''addressto''' - Адрес назначения
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
*'''price''' - Сумма наложенного платежа
*'''inshprice''' - Сумма объявленной ценности
*'''paytype''' - Тип оплаты
*'''userid''' - Идентификатор пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками "Цена доставки для получателя", определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенного покупателя.
*'''groupid''' - Идентификатор группы пользователя, строковый или числовой тип. Виртуальное поле. Необязательное. Данное поле используется совместно с настройками "Цена доставки для получателя", определяя приоритет правила. Можно использовать в различных CMS/CRM системах, настраивая цены для определенной группы покупателей.

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

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

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1163</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

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

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

== Получение информации о клиенте ==

'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="login" pass="pass" />
</client>
</source>

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

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<code>1082</code>
</client>
</source>

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
<auth extra="8" login="login" pass="pass" />
<datefrom>2016-02-10</datefrom>
<dateto>2016-03-10</dateto>
</smalist>
</source>

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

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
<sma>
<code>6278</code>
<number>3992</number>
<actdate>2016-02-12</actdate>
<datepay></datepay>
<dateto>2016-02-12</dateto>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<pricecorr>113.00</pricecorr>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
<signedcopyreceived>NO</signedcopyreceived>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

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

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
<specialsma>
<code>42494</code>
<ordercode>14424</ordercode>
<orderno>11111</orderno>
<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>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.

== Генерация коротких ссылок ==

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

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

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

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

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

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

API

2021-09-10T07:31:35Z

Johny: /* Готовые интеграции */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentation|HERE!]]'''
</div>

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

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

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

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

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==

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

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [https://courierexe.ru/download/api/bitrix.zip Скачать]
|Поддерживает версии 14.5 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше.
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|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_ос3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSales|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/wordpress.zip Скачать]
|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

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

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

[[Файл:extra1.png|750px]]

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

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

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].

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

== Оформление заказа ==
=== Пример оформления заказа ===

<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<items>
<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="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<overall_volume>81</overall_volume>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="login" pass="pass" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

*'''neworder''' - Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

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

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

*'''sender''' - Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

*'''receiver''' - Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

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

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

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

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

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

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

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

*'''costcode''' - Кост-код сотрудника.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

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

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

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</div>
<br />

=== Примеры ответов ===

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickup>NO</pickup>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<costcode>cc12345</costcode>
<receipt 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</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrival>2016-05-02 23:21</arrival>
<outstrbarcode>EXT123456</outstrbarcode>
<return_message>Доставлено в целости</return_message>
<department>Отдел</department>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</statusreq>
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

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

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

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

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

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

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

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

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

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

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
</commitlaststatus>
</source>

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

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

В случае успеха Вы получите ответ
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

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

== Трекинг заказа по номеру ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
</order>
</tracking>
</source>

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
}
]
}</pre>

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

== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* вместо корневого тэга '''neworder''' указывается '''editorder'''
* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.

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

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

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

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

== Добавление вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" size="35654">JVBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg" size="74861">VBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==

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

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

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<items>
<item code="34533" quantity="1" reason="0" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</image>
</order>
</setorderinfo>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==

'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
</waybill>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

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

== Справочник регионов ==

'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>1</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<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>
</city>
</regionlist>
</source>

== Справочник улиц ==

'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

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

*'''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>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==

'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<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>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

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

== Движение номенклатуры ==

'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</itemmovements>
</itemlist>
</source>

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

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

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

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

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

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

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

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

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Уфа город",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</source>

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

== Номенклатура приходной накладной ==

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

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

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

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

== Справочник филиалов ==

'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

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

== Справочник пунктов самовывоза ==

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

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<town>Нижний Тагил</town>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
*'''code''' - Внутренний код.
*'''client_code''' - Код клиента курьерской службы.
*'''town''' - Город получателя.
*'''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="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==

'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<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.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==

'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==

'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
<visible>NO</visible>
</advprices>
</source>

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

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

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

== Расчет стоимости доставки ==

'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
</order>
</calculator>
</source>

Параметры:
*'''pricetype''' - тип требуемой цены. Возможные значения: "CUSTOMER" (по-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], "CLIENT" - цена курьерской службы для клиента.
*'''townfrom''' - Город отправления
*'''addressfrom''' - Адрес отправления
*'''zipcode''' - Почтовый индекс города назначения
*'''townto''' - Город назначения
*'''addressto''' - Адрес назначения
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
*'''price''' - Сумма наложенного платежа
*'''inshprice''' - Сумма объявленной ценности
*'''paytype''' - Тип оплаты

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

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

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1163</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

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

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

== Получение информации о клиенте ==

'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="login" pass="pass" />
</client>
</source>

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

'''Пример ответа на запрос получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<code>1082</code>
</client>
</source>

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

== Список актов передачи денег ==

'''Пример запроса списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smalist>
<auth extra="8" login="login" pass="pass" />
<datefrom>2016-02-10</datefrom>
<dateto>2016-03-10</dateto>
</smalist>
</source>

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

'''Пример ответа на запрос списка актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smalist count="1">
<sma>
<code>6278</code>
<number>3992</number>
<actdate>2016-02-12</actdate>
<datepay></datepay>
<dateto>2016-02-12</dateto>
<promiseddatepay></promiseddatepay>
<price>637.00</price>
<pricecorr>113.00</pricecorr>
<rur>13430.00</rur>
<pricekur>570.00</pricekur>
<priceag>67.00</priceag>
<payno>42423</payno>
<paytype>1</paytype>
<paytypename>Безнал</paytypename>
<signedcopyreceived>NO</signedcopyreceived>
</sma>
</smalist>
</source>

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

== Детализация актов передачи денег ==

'''Пример запроса детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
<auth extra="8" login="login" pass="pass" />
<code>6278</code>
</smadetail>
</source>

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

'''Пример ответа на запрос детализации актов передачи денег:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<smadetail count="2">
<specialsma>
<code>42494</code>
<ordercode>14424</ordercode>
<orderno>11111</orderno>
<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>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.

== Генерация коротких ссылок ==

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

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

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

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

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

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

API

2021-09-01T15:00:08Z

Johny: /* Тестовый аккаунт */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentation|HERE!]]'''
</div>

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

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

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

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

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==

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

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [http://courierexe.ru/download/api/bitrix.zip Скачать]
|Поддерживает версии 14.5 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше.
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|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_ос3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSales|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/wordpress.zip Скачать]
|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

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

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: login пароль: pass.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

[[Файл:extra1.png|750px]]

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

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

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].

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

== Оформление заказа ==
=== Пример оформления заказа ===

<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<items>
<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="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<overall_volume>81</overall_volume>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="test" pass="testm" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

*'''neworder''' - Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

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

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

*'''sender''' - Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

*'''receiver''' - Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

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

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

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

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

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

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

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

*'''costcode''' - Кост-код сотрудника.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

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

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

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</div>
<br />

=== Примеры ответов ===

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickup>NO</pickup>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<costcode>cc12345</costcode>
<receipt 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</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrival>2016-05-02 23:21</arrival>
<outstrbarcode>EXT123456</outstrbarcode>
<return_message>Доставлено в целости</return_message>
<department>Отдел</department>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</statusreq>
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

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

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

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

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

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

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

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

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

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

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
</commitlaststatus>
</source>

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

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

В случае успеха Вы получите ответ
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

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

== Трекинг заказа по номеру ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
</order>
</tracking>
</source>

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
}
]
}</pre>

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

== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* вместо корневого тэга '''neworder''' указывается '''editorder'''
* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.

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

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

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

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

== Добавление вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" size="35654">JVBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg" size="74861">VBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==

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

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

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<items>
<item code="34533" quantity="1" reason="0" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</image>
</order>
</setorderinfo>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==

'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
</waybill>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

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

== Справочник регионов ==

'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>1</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<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>
</city>
</regionlist>
</source>

== Справочник улиц ==

'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

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

*'''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>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==

'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<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>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

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

== Движение номенклатуры ==

'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</itemmovements>
</itemlist>
</source>

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

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

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

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

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

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

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

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

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Уфа город",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</source>

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

== Номенклатура приходной накладной ==

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

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

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

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

== Справочник филиалов ==

'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

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

== Справочник пунктов самовывоза ==

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

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<town>Нижний Тагил</town>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
*'''code''' - Внутренний код.
*'''client_code''' - Код клиента курьерской службы.
*'''town''' - Город получателя.
*'''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="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==

'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="test" pass="testm" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<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.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==

'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==

'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
<visible>NO</visible>
</advprices>
</source>

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

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

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

== Расчет стоимости доставки ==

'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
</order>
</calculator>
</source>

Параметры:
*'''pricetype''' - тип требуемой цены. Возможные значения: "CUSTOMER" (по-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], "CLIENT" - цена курьерской службы для клиента.
*'''townfrom''' - Город отправления
*'''addressfrom''' - Адрес отправления
*'''zipcode''' - Почтовый индекс города назначения
*'''townto''' - Город назначения
*'''addressto''' - Адрес назначения
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
*'''price''' - Сумма наложенного платежа
*'''inshprice''' - Сумма объявленной ценности
*'''paytype''' - Тип оплаты

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

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

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1163</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

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

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

== Получение информации о клиенте ==

'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="test" pass="testm" />
</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>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.

== Генерация коротких ссылок ==

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

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

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

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

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

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>

API

2021-08-31T10:12:52Z

Johny: /* Расчет стоимости доставки */

<div style="font-size: 18px; color: #a92424; background-color: #ffdede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Изменения для 54-ФЗ'''

Для передачи ставки НДС при оформлении заказа добавлен атрибут items > item > VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС.

'''ВНИМАНИЕ'''

В ближайшем будущем при подключенной услуге кассового обслуживания система '''перестанет''' принимать заказы без состава вложений.

</div>

<div style="font-size: 24px; color: #2424a9; background-color: #deffde; border: 1px solid #ebccd1; padding: 3px 10px 10px; text-align: center">
'''English version is [[API documentation|HERE!]]'''
</div>

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

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

Если вы '''агрегатор''', передающий данные от клиентов, возможно, вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам.

Если вы '''подрядчик''', вы можете забирать заказы, используя значение client=AGENT в запросе [[#Пример запроса статуса заказа|statusreq]], и передавать статусы заказов, используя метод [[#Изменение статуса агентом|setorderinfo]]. Также для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание вашего сервиса, и мы с радостью его рассмотрим.

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

Если у вас после прочтения документации остались вопросы, задайте их по почте [mailto:support@courierexe.ru support@courierexe.ru]. Обязательно представьтесь, напишите ваши контактные данные (телефон, скайп) и название компании, с которой вы хотите интегрироваться.

== Готовые интеграции ==

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

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

Сообщайте нам свои пожелания по работе наших модулей. Мы учтем их в новых версиях.

{| class="wikitable" align="center" style="width: 80%; margin: auto; background-color:#ffffff; border: 1px solid #999999;" cellpadding="10" cellspacing="0"
!style="width: 35%;"|Система управления контентом (CMS)
!style="width: 15%;"|Ссылка
!style="width: 35%;"|Примечание
|-
|[[Файл:bitrix.png|center|x44px]]
|style="text-align: center;" | [http://courierexe.ru/download/api/bitrix.zip Скачать]
|Поддерживает версии 14.5 и выше. Подробнее см. [[Интеграция с другими системами#1C-Битрикс|описание]].
|-
|[[Файл:prestashop.png|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/prestashop.zip Скачать]
|Поддерживает версии 1.5.2.0 и выше.
|-
|[[Файл:OpencartOCStore.png|center|x60px]]
|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_ос3.ocmod.zip Скачать для версии 3.0]
|Поддерживает версии с 1.5.5.1.<br>Скачивайте модули для своей версии OpenCart.<br>Подробнее см. [[Интеграция с другими системами#OpenCart 1.5.5.1|описание]].<br>[https://opencartforum.com/files/file/2906-avtomatizaciya-otpravki-i-otslezhivanie-dostavok-courierexe-dlya-opencart-15x/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:webasyst-shopscript.png|center|x44px]]
|style="text-align: center;"|[https://www.webasyst.ru/store/plugin/shop/measoftcourier/ Установить модуль]<br>[https://www.webasyst.ru/store/plugin/shipping/measoftcourier/ Установить плагин]
|Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
|-
|[[Файл:advantshop.png|center|x44px]]
|style="text-align: center;"|[https://promo-z.ru/ Сайт компании PROMO]
|Компания PROMO разработала этот модуль и настраивает интеграцию MeaSoft с ADVANTSHOP своим клиентам.
|-
|[[Файл:insales.png|center|x80px]]
|style="text-align: center;"|Настраивается в [[Личный кабинет клиента|ЛК пользователя]]
|[[Интеграция с другими системами#InSales|Инструкция по настройке]]
|-
|[[Файл:Leadvertex.png|center|x44px]]
|style="text-align: center;"|[https://blog.leadvertex.ru/news/2110-integraciya-s-kurerkami-na-platforme-measoft Настраивается] в ЛК [https://Leadvertex.ru Leadvertex]
|[[Интеграция с другими системами#LeadVertex|Инструкция по настройке]]<br>Модуль разработан и поддерживается компанией LeadVertex.
|-
|[[Файл:Retailcrm.png|center|x30px]]
|style="text-align: center;"|[https://www.retailcrm.ru/ RetailCRM]
|[https://wiki.courierexe.ru/index.php?title=Интеграция_с_другими_системами#RetailCRM Настраивается] в ЛК пользователя в системе
|-
|[[Файл:1C.jpg|center|x44px]]
|style="text-align: center;"|-
|[https://infostart.ru/public/692790/ Альтернативный модуль сторонних разработчиков]
|-
|[[Файл:Joomla2.jpg|center|x60px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/com_measoft.zip Скачать]
|Работает только с компонентом Virtuemart.
|-
|[[Файл:Amocrm.png|center|x44px]]
|style="text-align: center;"|[https://www.amocrm.ru/extensions/courier2008 Установить]
|Подробнее см. [[Интеграция с другими системами#amoCRM|описание]].
|-
|rowspan="2"|[[Файл:MoySclad.jpg|center|x30px]]
|style="height:50px; text-align: center;"|[https://home.courierexe.ru/moysklad/step1 Настроить интеграцию с MeaSoft]
|[[Интеграция с другими системами#МойСклад|Инструкция]]
|-
|style="height:50px; text-align: center;"|[https://itmdev.ru/ms/shipping/ Скачать модуль сторонних разработчиков]
|Интеграция МойСклад с курьерскими службами от сторонних разработчиков
|-
|[[Файл:wordpress.jpg|center|x80px]]
|style="text-align: center;"|[https://courierexe.ru/download/api/wordpress.zip Скачать]
|[[Интеграция с другими системами#Wordpress|Инструкция]]
|-
|[[Файл:Cscart.png|center|x60px]]
|style="text-align: center;"|[https://marketplace.cs-cart.com/measoft-en.html Установить]
|Поддерживает версии 4.10 и выше.<br>[[Интеграция с другими системами#CS-Cart|Инструкция]]
|-
|}

'''Обратите внимание!''' В модулях систем PrestaShop и Joomla для отправки заказа в курьерскую службу зайдите в карточку заказа. В карточке отображается специальная форма отправки заказа, а если заказ отправлен, она позволяет проверить его статус:[[Файл:Form.png|400 px|Форма отправки заказа|none]]

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

== Тестовый аккаунт ==

Для отладки зайдите в тестовый личный кабинет по адресу [https://home.courierexe.ru/8 https://home.courierexe.ru/8], логин: test пароль: testm.

На вкладке '''Интеграция''' > '''Отладка''' вы можете пробовать выполнять запросы к API для отладки, а также видеть историю отправленных запросов. Созданные заказы появятся в пункте основного меню '''Отслеживание'''.

Для упрощения интеграции можно скачать [https://courierexe.ru/download/api/php_sample.zip пример обращения к сервису на PHP].

== Рабочий аккаунт для подключения ==

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

[[Файл:extra1.png|750px]]

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

3. '''Пароль''' - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке '''"Прочее"''' в поле '''"Пароль"''' (на скриншоте ниже).

[[Файл:33_client.png|500px]]

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

Для использования интеграции в «боевом» режиме, запросите '''логин''', '''пароль''', и параметр '''extra''' у той компании, с которой интегрируетесь.

Вы можете отправлять тестовые запросы к нашему сервису и видеть историю отправленных запросов в личном кабинете на закладке '''Интеграция'''.

Клиент отправляет запросы к сервису методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML.
Кодировка — UTF-8. Разделитель целой и дробной частей чисел — используется символ точки. Даты представляются в виде YYYY-MM-DD, время — HH:MM.

В силу [https://ru.wikipedia.org/wiki/XML#.D0.A0.D0.B5.D1.88.D0.B5.D0.BD.D0.B8.D0.B5_.D0.BF.D1.80.D0.BE.D0.B1.D0.BB.D0.B5.D0.BC.D1.8B_.D0.BD.D0.B5.D0.BE.D0.B4.D0.BD.D0.BE.D0.B7.D0.BD.D0.B0.D1.87.D0.BD.D0.BE.D1.81.D1.82.D0.B8_.D1.80.D0.B0.D0.B7.D0.BC.D0.B5.D1.82.D0.BA.D0.B8 особенностей языка XML], некоторые символы в тексте должны быть заменены: & на &amp; < на &lt; > на &gt; " на &quot;

Наше API принципиально работает только по HTTPS, так как передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить [http://courierexe.ru/download/api/proxy.zip прокси на PHP]. <spoiler text="Как запустить">Для теста можете запустить его на сервере следующей командой: php -S <IP>:8080 proxy.php
где <IP> — это адрес вашего сервера, а 8080 порт, на котором будут приниматься запросы.
Тогда для обмена данными с нашим АПИ необходимо будет использовать адрес <IP>:8080</spoiler>
Доступность функций, описанных в этом разделе, зависит от [[Личный кабинет курьерской службы#Функции личного кабинета|тарифа вашего личного кабинета]].

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

В случае превышения IP-адрес или аккаунт блокируется на время до 3-х часов.

Чтобы не происходило блокировок:
* не нужно «бомбить» наше API запросами статусов, последовательно перебирая номера всех ваших заказов, особенно запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 00 минут каждого часа;
* не нужно каждые 5 минут делать запросы «Покажите статусы всех заказов за последние 3 месяца»;
* для проверки статусов заказов лучше всего использовать запросы [[#Передача только изменившихся статусов|измененных статусов changes=ONLY_LAST]];
* при запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом [[#Передача только изменившихся статусов|commitlaststatus]].

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

== Оформление заказа ==
=== Пример оформления заказа ===

<source lang=xml>
<?xml version="1.0" encoding="UTF-8"?>
<neworder newfolder="NO">
<auth extra="8" login="login" pass="pass"></auth>
<order orderno="111111">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<inn>1112223335</inn>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<deliveryPIN>1234</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<return>NO</return>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>1</return_service>
<type>3</type>
<return_type>3</return_type>
<courier>22</courier>
<price>387.5</price>
<deliveryprice VATrate="20">150</deliveryprice>
<inshprice>387.5</inshprice>
<receiverpays>NO</receiverpays>
<discount>120</discount>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<department>Отдел</department>
<pickup>NO</pickup>
<acceptpartially>NO</acceptpartially>
<costcode>cc12345</costcode>
<items>
<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="ООО "Рога и копыта"" suppphone="79161234567" suppINN="1112223334" governmentCode="11223311">Мяч</item>
<item extcode="abc124" quantity="2" mass="2" retprice="100" inshprice="100" VATrate="10" barcode="4645625213138" article="2" length="10" width="20" height="30" origincountry="004">Обруч</item>
<item extcode="abc125" quantity="3" mass="0.3" retprice="50" inshprice="50" barcode="2345625213126" itemcode="44123" article="3" type="1">Погремушка желтая</item>
</items>
<packages>
<package strbarcode="ORD0000001" mass="1" message=""></package>
<package strbarcode="ORD0000002" mass="2.5" message="" length="10" width="20" height="30"></package>
</packages>
<deliveryset above_price="100" return_price="1000" VATrate="10">
<below below_sum="500" price="500" />
<below below_sum="2000" price="300" />
</deliveryset>
<advprices>
<advprice>
<code>1</code>
<value>123</value>
</advprice>
<advprice>
<code>2</code>
<value>10.5</value>
</advprice>
<advprice>
<code>3</code>
<value>true</value>
</advprice>
</advprices>
<overall_volume>81</overall_volume>
</order>
</neworder>
</source>

=== Описание элементов для оформления заказа ===
'''Обязательные поля'''

Обязательными на уровне системы являются только 3 поля: receiver->company или receiver->person, receiver->address и receiver->phone. Так же в настройках системы сама курьерская служба может назначить какие-то дополнительные поля обязательными, тогда, если вы их не укажете, получите сообщение об ошибке.
<spoiler text="Пример минимально возможного заказа">
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<auth extra="8" login="test" pass="testm" />
<order>
<receiver>
<company>МВД</company>
<phone>(495)123-45-67</phone>
<address>Петровка, 38</address>
</receiver>
</order>
</neworder>
</source>
</spoiler>

'''Описание полей'''

*'''neworder''' - Корневой контейнер, обязательный элемент.

:* '''''newfolder''''' - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

*'''order''' - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере '''neworder''' может быть много контейнеров '''order''' для создания нескольких заказов одним запросом.

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

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

*'''sender''' - Информация о отправителе заказа. Необязательный контейнер.
<source lang="xml">
<sender>
<company>Название компании отправителя</company>
<person>Контактное лицо отправителя</person>
<phone>Телефон, Email отправителя</phone>
<town>Город отправителя в формате "Москва город"</town>
<address>Адрес отправителя</address>
<date>Дата забора в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время забора в формате "HH:MM"</time_min>
<time_max>Желаемое время забора в формате "HH:MM"</time_max>
</sender>
</source>

*'''receiver''' - Информация о получателе заказа. Обязательный контейнер.
<source lang="xml">
<receiver>
<company>Название компании получателя</company>
<person>Контактное лицо получателя</person>
<phone>Телефон, Email получателя</phone>
<town regioncode="Код региона">Город получателя в формате "Москва город"</town>
<address>Адрес получателя</address>
<inn>ИНН получателя</inn>
<pvz>Код пункта самовывоза по справочнику</pvz>
<date>Дата доставки в формате "YYYY-MM-DD"</date>
<time_min>Желаемое время доставки в формате "HH:MM"</time_min>
<time_max>Желаемое время доставки в формате "HH:MM"</time_max>
<deliveryPIN>Пин-код для подтверждения получателем</deliveryPIN>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
</source>

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

Для тега города '''town''' можно указать код региона в атрибуте '''''regioncode''''' из [[#Справочник регионов|справочника регионов]]. Поиск будет производиться в указанном регионе.

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

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге '''zipcode'''.

Поле '''Город''' контейнеров '''sender''' и '''receiver''' можно указать одним из следующих способов:
:* код населенного пункта из [[#Справочник городов|справочника городов]]
:* 13-ти значный код адресного классификатора КЛАДР
:* 36-ти значный код адресной системы <rspoiler text="ФИАС">Федеральная информационная адресная система — единый российский государственный адресный реестр</rspoiler> (AOID)
:* название города (не рекомендуется!)

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

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

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

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

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

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

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

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

*'''costcode''' - Кост-код сотрудника.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
При передаче заказов, у которых плановая дата доставки/забора меньше ближайшей возможной, дата автоматически меняется на самую раннюю возможную. [[Личный_кабинет_курьерской_службы#Как считается минимальная дата возможной доставки|Подробнее]]</div>

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

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

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="0" errormsg="Success" errormsgru="Успешно" orderprice="5000" />
<createorder orderno="AB23542" barcode="67567#115" error="0" errormsg="Success" errormsgru="Успешно" orderprice="6000" />
<createorder orderno="AB23543" barcode="67567#116" error="0" errormsg="Success" errormsgru="Успешно" orderprice="0" />
</neworder>
</source>

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<neworder>
<createorder orderno="AB23541" barcode="67567#114" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
<createorder orderno="AB23542" barcode="67567#115" error="17" errormsg="Order number already exists in the database." errormsgru="Такой номер заказа уже есть в базе." />
<createorder orderno="AB23543" barcode="67567#116" error="67" errormsg="Order barcode already exists in the database." errormsgru="Такой штрихкод заказа уже есть в базе." />
</neworder>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

== Запрос статуса заказов ==

=== Пример запроса статуса заказа ===

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
<orderno>1234</orderno>
<orderno2>5678</orderno2>
<ordercode>34234</ordercode>
<givencode>234534</givencode>
<datefrom>2016-07-21</datefrom>
<dateto>2016-07-21</dateto>
<target>Автозавод</target>
<done>ONLY_NOT_DONE</done>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

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

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

*'''changes''' - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: [[#Передача только изменившихся статусов|Передача только изменившихся статусов]]

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Периода запроса статусов (контейнеры '''datefrom''' и '''dateto''') ограничивается двумя месяцами — два месяца до даты '''"по"'''.
# Если не указаны обе даты — '''dateto''' принимается равной текущей дате.
# Если не указана дата '''dateto''' — она принимается равной '''datefrom''' плюс 2 месяца.
# Если не указана дата '''datefrom''' — она принимается равной '''dateto''' минус 2 месяца.
</div>
<br />

=== Примеры ответов ===

'''Пример успешного ответа'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
<order orderno="111111" awb="qwerty" orderno2="123123" ordercode="34534234" givencode="2345334">
<barcode>111111</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<contacts>
<phone>+74951234567</phone>
</contacts>
<town code="23432">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67 - Иван (916)234.45.21 Петр,mvd@mail.ru</phone>
<contacts>
<phone>+74951234567</phone>
<phone>+79162344521</phone>
<email>mvd@mail.ru</email>
</contacts>
<inn>1112223335</inn>
<zipcode>125480</zipcode>
<town code="153361" regioncode="78" regionname="Санкт-Петербург город">Санкт-Петербург город</town>
<address>Петровка 38 офис 35</address>
<pvz>
<code>126</code>
<clientcode>QWERTY</clientcode>
</pvz>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
<coords lat="55.680327" lon="37.604456"></coords>
<deliveryPIN>1234</deliveryPIN>
</receiver>
<pickup>NO</pickup>
<weight>5.1</weight>
<return_weight>5.1</return_weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<return_service>2</service>
<type>3</type>
<return_type>3</return_type>
<waittime>12</waittime>
<price>387.5</price>
<print_check>YES</print_check>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45"></currcoords>
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<deliveryprice total="158.6" delivery="100.00" return="58.6">
<advprice code="1" price="150">База</advprice>
<advprice code="2" price="0">% от объявленной стоимости</advprice>
<advprice code="3" price="8.6">Топливный сбор</advprice>
<advprice code="4" price="0">Округление</advprice>
</deliveryprice>
<receiverpays>NO</receiverpays>
<acceptpartially>NO</acceptpartially>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<customstatecode>2<customstatecode>
<clientstatecode></clientstatecode>
<costcode>cc12345</costcode>
<receipt 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</receipt>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<arrival>2016-05-02 23:21</arrival>
<outstrbarcode>EXT123456</outstrbarcode>
<return_message>Доставлено в целости</return_message>
<department>Отдел</department>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" itemcode="44123" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
<packages>
<package code="33331" strbarcode="ORD0000001" mass="1" message="" got="YES"></package>
<package code="33332" strbarcode="ORD0000002" mass="2.5" message="" got="NO"></package>
</packages>
</order>
</statusreq>
</source>

'''Пример ответа если нет заказов'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>
</source>

'''Пример ответа при ошибке авторизации'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>
</source>

'''Пример ответа при ошибке синтаксиса'''

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<request>
<error>column:1 line:11 message:expected '>'</error>
</request>
</source>

=== Описание полей ответа статусов ===
Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

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

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

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

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

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

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

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

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

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

: RETURNING — Планируется возврат заказчику (после CANCELED).
: RETURNED — Возвращен заказчику.
: LOST — Утрачен/утерян.

'''Примечание.''' В будущем возможно дополнение используемого набора статусов.

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

# Контейнер '''statushistory''' и '''deliveryprice''' заполняется для тарифов [[Личный кабинет курьерской службы#Функции личного кабинета|Премиум и Максимум]].
# Система никогда не гарантирует последовательность прохождения заказом набора статусов. Т.е. Вы можете получить статус "COMPLETE", а следующим запросом - "NEW" - такое может произойти, например, если оператор ошибочно отметил заказ выполненным, а затем исправил ошибку.
</div>
<br />

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

Для получения только изменившихся статусов отправьте запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
<auth extra="8" login="login" pass="pass"></auth>
<changes>ONLY_LAST</changes>
</statusreq>
</source>

Система выдает все заказы, в которых, с момента последнего запроса в этом режиме, изменилось хотя бы одно из полей:
orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

После успешной обработки ответа необходимо отметить полученные статусы успешно полученными, отправив запрос
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
<auth extra="8" login="login" pass="pass"></auth>
<client>CLIENT</client>
</commitlaststatus>
</source>

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

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

В случае успеха Вы получите ответ
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>
</source>

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''

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

== Трекинг заказа по номеру ==

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

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<extra>8</extra>
<orderno>1234</orderno>
</tracking>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking>
<order orderno="111111">
<barcode>111111</barcode>
<AWB>111111</AWB>
<sender>
<town code="1" country="RU">Москва город</town>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<town code="1" country="RU">Москва город</town>
<zipcode>125480</zipcode>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<price>387.5</price>
<inshprice>387.5</inshprice>
<paytype>CASH</paytype>
<weight>5.1</weight>
<quantity>2</quantity>
<service>2</service>
<type>3</type>
<return>NO</return>
<return_service>2</service>
<return_date></return_date>
<return_time></return_time>
<return_message></return_message>
<waittime>12</waittime>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
<deliveryprice total="158.6" delivery="100.00" return="58.6" />
<courier>
<code>26</code>
<name>Иванов Владимир Петрович</name>
<phone>+79161234567</phone>
</courier>
<currcoords lat="55.680327" lon="37.604456" accuracy="50" RequestDateTime="2014-04-21 18:07:45" />
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
<statushistory>
<status eventstore="Офис в Москве" eventtime="2016-05-30 10:20:00" createtimegmt="2016-06-03 16:14:44" message="" title="Новый">NEW</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 17:38:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Планируется отправка">DEPARTURING</status>
<status eventstore="Офис в Москве" eventtime="2016-06-01 19:53:00" createtimegmt="2016-06-03 16:14:44" message="филиал в Санкт-Петербурге" title="Отправлено со склада">DEPARTURE</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 07:41:00" createtimegmt="2016-06-03 16:14:44" message="" title="Получен складом">ACCEPTED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 09:17:00" createtimegmt="2016-06-03 16:14:44" message="" title="Выдан курьеру на доставку">DELIVERY</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен (предварительно)">COURIERDELIVERED</status>
<status eventstore="филиал в Санкт-Петербурге" eventtime="2016-06-02 17:22:00" createtimegmt="2016-06-03 16:14:44" message="" title="Доставлен">COMPLETE</status>
</statushistory>
<deliveredto>Иванова, секр.</deliveredto>
<delivereddate>2016-06-02</delivereddate>
<deliveredtime>17:22</deliveredtime>
<outstrbarcode>EXT123456</outstrbarcode>
<items>
<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" suppcompany="Поставщик" suppINN="1112223334" suppphone="79161234567">Мяч</item>
<item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" VATrate="10" barcode="4645625213138" article="2" returns="0" governmentCode="">Обруч</item>
<item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" VATrate="18" barcode="2345625213126" article="3" returns="0" governmentCode="">Погремушка желтая</item>
</items>
</order>
</tracking>
</source>

'''Получение информации в формате 17 TRACK'''

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
<extra>8</extra>
<orderno>1234</orderno>
</tracking17>
</source>

'''Пример ответа:'''
<pre>{
"number":"ExtNumber",
"oriNumber":"1234",
"oriCountry":"RU",
"destCountry":"RU",
"status":"Complete",
"events":[
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Complete"
},
{
"time":"2016-06-02 17:22:00",
"location":"RU",
"content":"Courierdelivered"
},
{
"time":"2016-06-02 09:17:00",
"location":"RU",
"content":"Delivery"
},
{
"time":"2016-06-02 07:41:00",
"location":"RU",
"content":"Accepted"
},
{
"time":"2016-06-01 19:53:00",
"location":"RU",
"content":"Departure"
},
{
"time":"2016-06-01 17:38:00",
"location":"RU",
"content":"Departuring"
},
{
"time":"2016-05-30 10:20:00",
"location":"RU",
"content":"New"
}
]
}</pre>

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

== Изменение заказа ==
Запрос предназначен для изменения заказов, по которым не было произведено изменений статуса корреспонденции, времени доставки — то есть заказов, которые ещё не в работе.

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

<div style="color: #a94442; background-color: #f2dede; border: 1px solid #ebccd1; padding: 3px 10px 10px;">
'''Обратите внимание!'''
# Данные запроса изменения указываются '''полностью''', как если бы заказ создавался впервые.
# При отсутствии вложения в запросе изменения данное вложение '''не удаляется''' из заказа, но его количество становится равным 0.
# При одновременном изменении заказа в API и системе курьерской службы приоритет отдается данным системы курьерской службы. То есть изменения в API приняты не будут!
</div>
<br>

=== Описание полей запроса изменения ===
Все поля запроса соответствуют структуре order при создании заказа за исключением:
* вместо корневого тэга '''neworder''' указывается '''editorder'''
* тэг штрих-кода '''barcode''' не указывается, поскольку присваивается при создании заказа.
* для вложений '''item''' указывается внутренний код вложения в атрибуте '''code''', который можно получить при получении статуса заказа.

=== Описание полей ответа изменения ===
Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга — вместо '''neworder''' возвращается '''editorder'''.

== Отмена заказа ==
Запрос предназначен для отмены заказов, по которым не было произведено изменений статуса доставки, статуса корреспонденции, времени доставки, то есть заказов, которые ещё не в работе.

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

При отмене заказа поле «Инфо о доставке» получает значение «Отменено заказчиком», поле «Дата доставки» — текущую дату, а «Вручил курьер» — системную запись «ОТМЕНА».

'''Пример запроса отмены заказа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
<auth extra="8" login="login" pass="pass" />
<order orderno="" ordercode="123456" />
<order orderno="123aaa" ordercode="" />
</cancelorder>
</source>

'''Описание полей:'''

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

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

== Добавление вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<addattachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
<attachments>
<item name="photo1.jpg">JVBERi0xLjMN1wb25lbnQgMQ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg">VBERi0xLjMNAwIG9iag0HRoJ
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</addattachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<addattachments>
<attachments>
<item name="photo1.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
<item name="photo2.jpg" error="0" errormsg="OK" errormsgru="Успешно" />
</attachments>
</addattachments>
</source>

== Получение вложений к накладной ==

'''Пример запроса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
<auth extra="8" login="login" pass="pass" />
<orderno>1234567</orderno>
</attachments>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<attachments>
<item name="doc1.docx" size="35654">JVBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
U3VidHlwZSAvSW1hZ2UNL1d pZHRoIDE4MDgNL0hlaWdodCA
ggNCAwIFINL0JpdHNQZXJDb 21wb25lbnQgMQ0vRGVjb2RlU
ENL0NvbHVtbnMgMTgwOA0+P g0vSW1hZ2VNYXNrIHRydWUNL
XhEZWNvZGUNPj4Nc3RyZWFt DQ</item>
<item name="photo2.jpg" size="74861">VBERi0xLjMN
JUBQREYwMTIzNDU2Nzg5IDI NMyAwIG9iag08PA0vVHlwZSA
vWE9iamVjdA0vU3VidHlwZS AvSW1hZ2UNL1dpZHRoIDEzNj
gNL0hlaWdodCAxMzMzDS9MZ W5ndGggNCAwIFINL0JpdHNQZ
XJDb21wb25lbnQgMQ0vRGVj b2RlUGFybXMgPDwNL0sgLTEN
L0NvbHVtbnMgMTM2OA0+Pg0 vSW</item>
</attachments>
</source>

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

== Изменение статуса агентом ==

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

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

При необходимости к заказу можно прикрепить изображения.

'''Пример запроса изменения статуса:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
<auth extra="8" login="login" pass="pass" />
<order ordercode="123456">
<message>Получил Иванов</message>
<outstrbarcode>7654312</outstrbarcode>
</order>
<order ordercode="234567">
<status>PICKUPREADY</status>
<eventtime>2016-05-30 10:20:00</eventtime>
<message>Клиент отказался от покупки</message>
<paytype>CASH</paytype>
<items>
<item code="34533" quantity="1" reason="0" />
<item code="34456" quantity="0" reason="0" />
<item code="34421" quantity="2" reason="0" />
</items>
<image filename="filename1.jpg"> /9j/4AAQSkZJRgA
BAQAAAQABAAD/2wBDAA0JCg sKCA0LCgsODg0PEyAVExISEy
ccHhcgLikxMC4pLSwzOko+M zZGNywtQFdBRkxOUlNSMj5aY
VpQYEpRUk//2wBDAQ4ODhMR EyYVFSZPNS01T09PT09PT09P
T09PT09PT09PT09PT09PT09 PT09PT09PT09PT09PT09PT09
PT09PT0//wAARCAYACAADAS IA</image>
</order>
</setorderinfo>
</source>

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<setorderinfo>
<order ordercode="123456" error="0" errormsg="OK" errormsgru="Успешно" />
<order ordercode="234567" error="59" errormsg="value [date_put] is already set" errormsgru="Значение [Дата доставки] уже указано" />
</setorderinfo>
</source>

== Получение документов для печати ==

'''Пример запроса получения печатных форм:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<waybill>
<auth extra="8" login="login" pass="pass" />
<orders>
<order orderno="1234567" ordercode="33331" />
<order orderno="1234568" ordercode="33332" />
</orders>
<form>1</form>
</waybill>
</source>

'''Описание полей:'''

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<waybill>
<content>EODIcaI8KSBlwQ 4MnEOR7Px8U8EBAyGICBnwpw
IZhQgz0ZxuPs8EBM/GcbjzB AwhBl8hwQYIO00GmEwg1CeEG
mqYTChNU0wqf8l8nz4zgc+K fCno+zwU5GjOZmzXGcbEQYIM
4zkegRE40zWzONyoNNMIOIa cWnp6aDCGEGE9NQmoQd2mg00
79U4f3hPTwnfp6Sdrafeqpa JDpFw/1aYT077VNNNdO00G3q
mqqvp9p2E7T0/wiFemv8uG6 OM</content>
</waybill>
</source>

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

== Справочник городов ==

'''Пример запроса справочника городов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist>
<auth extra="8" />
<codesearch>
<zipcode>110000</zipcode>
<kladrcode>0100000100800</kladrcode>
<fiascode>bd21979d-46f8-49d0-9105-e8d65172a983</fiascode>
<code>123</code>
</codesearch>
<conditions>
<city>Краснодарский край</city>
<namecontains>новгород</namecontains>
<namestarts>Моск</namestarts>
<name>Москва</name>
<fullname>Москва город</fullname>
<country>1</country>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</townlist>
</source>

Внутри контейнера townlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<townlist count="3" page="1" totalcount="3" totalpages="1">
<town>
<code>26379</code>
<city>
<code>23</code>
<name>Краснодарский край</name>
</city>
<name>Сочи город</name>
<fiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode>
<kladrcode>2300000700000</kladrcode>
<shortname /> (not yet supported)
<typename /> (not yet supported)
<coords lat="43.5855" lon="39.7231" />
</town>
<town>
<code>40331</code>
<city>
<code>32</code>
<name>Брянская область</name>
</city>
<name>Сочилов хутор</name>
<fiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode>
<kladrcode>3201900011100</kladrcode>
<shortname />
<typename />
<coords lat="52.6407" lon="33.1724" />
</town>
<town>
<code>114016</code>
<city>
<code>60</code>
<name>Псковская область</name>
</city>
<name>Сочихино деревня</name>
<fiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode>
<kladrcode>6001900015400</kladrcode>
<shortname />
<typename />
<coords lat="56.6003" lon="29.3542" />
</town>
</townlist>
</source>

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

== Справочник регионов ==

'''Пример запроса справочника:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist>
<codesearch>
<code>77</code>
</codesearch>
<conditions>
<namecontains>край</namecontains>
<namestarts>Моск</namestarts>
<fullname>Московская область</fullname>
<country>1</country>
</conditions>
</regionlist>
</source>

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<regionlist count="2">
<city>
<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>
</city>
</regionlist>
</source>

== Справочник улиц ==

'''Пример запроса справочника улиц:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<streetlist>
<conditions>
<town>Москва город</town> // ОБЯЗАТЕЛЬНОЕ ПОЛЕ!
<namecontains>Хохло</namecontains>
<namestarts>Академика Х</namestarts>
<name>Академика Хохлова</name>
<fullname>Академика Хохлова ул.</fullname>
</conditions>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</streetlist>
</source>

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

*'''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>
<name>Академика Хохлова ул.</name>
<shortname>Академика Хохлова</shortname>
<typename>ул.</typename>
</street>
</streetlist>
</source>

В ответе улицы сортируются по алфавиту.

== Справочник номенклатуры ==

'''Пример запроса справочника номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemlist>
<auth extra="8" login="login" pass="pass"></auth>
<codesearch>
<code>123456</code>
<article>FD343</article>
<barcode>2345625213125</barcode>
</codesearch>
<conditions>
<namecontains>телевизор</namecontains>
<namestarts>sony</namestarts>
<name>Sony KDL-55W905 ЖК-телевизор</name>
<quantity>EXISTING_ONLY</quantity>
<store>2</store>
</conditions>
<except>
<code>123478</code>
</except>
<limit>
<limitfrom>30</limitfrom>
<limitcount>10</limitcount>
<countall>YES</countall>
</limit>
</itemlist>
</source>

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

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

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

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<itemlist count="3" totalcount="3" page="1" totalpages="1">
<item>
<code>123456</code>
<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>
<HasSerials>1</HasSerials>
<CountryOfOrigin>Малайзия</CountryOfOrigin> (not yet supported)
<Message>Хороший телевизор</Message>
<Message2>Снова хороший телевизор</Message2>
<quantity>12</quantity>
<reserved>3</reserved>
<item>
...
</itemlist>
</source>

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

== Движение номенклатуры ==

'''Пример запроса движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
<auth extra="8" login="login" pass="pass"></auth>
<code>4259</code>
<datefrom>2020-10-01</datefrom>
<dateto>2020-10-02</dateto>
</itemmovements>
</source>

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements count="16">
<itemmovement>
<code>151500</code>
<date>2017-05-26</date>
<retprice>0</retprice>
<quantity>1</quantity>
<delivered>0</delivered>
<item>
<code>4259</code>
<name>Настольная игра Дженга</name>
</item>
<status>
<code>5</code>
<name>Возврат от покупателя</name>
</status>
<store>
<code>1</code>
<name>офис в Москве</name>
</store>
<order>
<ordercode>3374830</ordercode>
<number>123660-0</number>
<date>2017-05-24</date>
<orderno>14123</orderno>
<barcode>0000000670</barcode>
<company>ТОВАР</company>
<address>Кравченко ул., 1</address>
<delivereddate>2017-05-29</delivereddate>
<deliveredtime>12:00:00</deliveredtime>
<deliveredto />
</order>
<document>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
</document>
</itemmovements>
</itemlist>
</source>

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

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

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

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

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

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

== Получение справочника тарифов по городам ==

'''Пример запроса справочника тарифов по городам'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<tariffs>
<auth extra="8" login="login" pass="pass" />
<townfrom>Москва</townfrom>
<service>1</service>
<mainonly>1</mainonly>
</tariffs>
</source>

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

'''Пример ответа справочника тарифов по городам'''
<source lang="json">
{
"townfrom": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"service": 1,
"tariffs": [
{
"towntofias": "7339e834-2cb4-4734-a4c7-1fca2c66e562",
"towntocode": "482",
"towntoname": "Уфа город",
"pricesnew": {
"before": [
{
"price": "100",
"every": "0",
"mass": "1"
},
{
"price": "200",
"every": "1",
"mass": "2"
}
],
"after": [
{
"price": "300",
"every": "1",
"mass": "3"
}
]
},
"prices": {
"before": {
"mass": "3",
"price": "202.5"
},
"after": {
"mass": "3",
"every": "1",
"price": "18.75"
}
},
"deliveryPeriodMin": 4,
"deliveryPeriodMax": 5
}
]
}
</source>

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

== Номенклатура приходной накладной ==

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

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

'''Пример ответа движения номенклатуры:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<itemdoc>
<code>21991</code>
<number>318</number>
<date>2017-05-26</date>
<message></message>
<items>
<item code="4259" quantity="1" barcode="200300" article="123555">Настольная игра Дженга</item>
</items>
</itemdoc>
</source>

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

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

== Справочник филиалов ==

'''Пример запроса списка филиалов:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
<auth extra="8"></auth>
<json>YES</json>
<client_code>7890</client_code>
</storelist>
</source>

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

'''Пример ответа:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<storelist count="2">
<store>
<code>123</code>
<name>ABC</name>
</store>
<store>
<code>456</code>
<name>Филиал 2</name>
</store>
</storelist>
</source>

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

== Справочник пунктов самовывоза ==

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

'''Пример запроса пунктов самовывоза:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
<auth extra="8" login="login" pass="pass"></auth>
<code>1234</code>
<client_code>7890</client_code>
<town>Нижний Тагил</town>
<parentcode>6</parentcode>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<maxweight>30</maxweight>
<acceptindividuals>YES</acceptindividuals>
<lt>57.924737</lt>
<lg>59.940019</lg>
<rt>57.905682</rt>
<rg>59.984669</rg>
<json>YES</json>
<limit>
<limitfrom>30</limitfrom>
<limitcount>2</limitcount>
<countall>YES</countall>
</limit>
</pvzlist>
</source>

*'''auth''' - Атрибут '''extra''' - обязателен, по нему определяется курьерская служба, '''login''' и '''pass''' позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
*'''code''' - Внутренний код.
*'''client_code''' - Код клиента курьерской службы.
*'''town''' - Город получателя.
*'''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="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2" totalcount="40465">
<pvz>
<code>126</code>
<clientcode>3</clientcode>
<name>Нижний Тагил</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
<phone>+73435417709, +73435254989</phone>
<comment>Новый пункт доставки</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского</traveldescription>
<maxweight>10</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>YES</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93457</latitude>
<longitude>59.95131</longitude>
<uid>40606d00-9c51-11eb-b2c9-cfd6c1111392</uid>
</pvz>
<pvz>
<code>245</code>
<clientcode>NTG1</clientcode>
<name>На Красноармейской</name>
<parentcode>6</parentcode>
<parentname>Интеграция</parentname>
<town code="124267" regioncode="66" regionname="Свердловская область">Нижний Тагил город</town>
<address>КРАСНОАРМЕЙСКАЯ, д.79</address>
<phone>+7(3435)379-044</phone>
<comment>Возможность примерки отсутствует</comment>
<worktime>Вс 10:00-16:00, Сб 10:00-16:00, Пн-Пт 10:00-20:00</worktime>
<traveldescription>Напротив ТЦ Пирамида</traveldescription>
<maxweight>20</maxweight>
<acceptcash>YES</acceptcash>
<acceptcard>YES</acceptcard>
<acceptfitting>NO</acceptfitting>
<acceptindividuals>YES</acceptindividuals>
<latitude>57.93468</latitude>
<longitude>60.55476</longitude>
<uid>41116853-9c51-11eb-b2c9-cfd6c1451392</uid>
</pvz>
</pvzlist>
</source>

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

== Получение фискальных данных заказа ==

'''Пример запроса получения фискальных данных:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
<auth extra="8" login="test" pass="testm" />
<orders>
<order orderno="123456" />
<order orderno="890111C" />
</orders>
</receiptdata>

</source>

'''Пример ответа получения фискальных данных:'''
<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.ofd.ru</ofdUrl>
<fullUrl>https://check.ofd.ru/123</fullUrl>
<price>12345</price>
<lines count="1">
<line>
<item>1111764</item>
<name>Сапоги</name>
<qty>1</qty>
<price>1000</price>
<vatRate>20</vatRate>
<governmentCode>Z16513LK2</governmentCode>
<itemType>1</itemType>
</line>
</lines>
</receipt>
</receipts>
</source>

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

== Справочник Виды срочности ==

'''Пример запроса видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>
</source>

'''Пример ответа справочника видов срочности:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<services count="2">
<service>
<code>1</code>
<name>Эконом</name>
</service>
<service>
<code>2</code>
<name>Срочно</name>
</service>
</services>
</source>

== Справочник дополнительных услуг ==

'''Пример запроса дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<advprices>
<auth extra="8" login="login" pass="pass" />
<visible>NO</visible>
</advprices>
</source>

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

'''Пример ответа справочника дополнительных услуг:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<advprices>
<advprice>
<code>1</code>
<name>Этажей в доме</name>
<type>int</type>
</advprice>
<advprice>
<code>2</code>
<name>Коэффициент надбавки</name>
<type>float</type>
</advprice>
<advprice>
<code>3</code>
<name>Расписаться на упаковке</name>
<type>bool</type>
</advprice>
</advprices>
</source>

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

== Расчет стоимости доставки ==

'''Пример запроса стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
<auth extra="8" login="login" pass="pass" />
<order>
<pricetype>CUSTOMER</pricetype>
<sender>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<coords lat="55.680327" lon="37.604456"></coords>
</sender>
<receiver>
<zipcode>125480</zipcode>
<town regioncode="78" country="RU">Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<pvz>124</pvz>
<coords lat="55.680327" lon="37.604456"></coords>
</receiver>
<weight>5.1</weight>
<service>2</service>
<paytype>CASH</paytype>
<price>387.5</price>
<deliveryprice>150</deliveryprice>
<inshprice>387.5</inshprice>
<packages>
<package mass="1"></package>
<package mass="2.5" length="10" width="20" height="30"></package>
</packages>
</order>
</calculator>
</source>

Параметры:
*'''pricetype''' - тип требуемой цены. Возможные значения: "CUSTOMER" (по-умолчанию) - [[Личный кабинет клиента#Цена доставки для получателя|цена для конечного получателя]], "CLIENT" - цена курьерской службы для клиента.
*'''townfrom''' - Город отправления
*'''addressfrom''' - Адрес отправления
*'''zipcode''' - Почтовый индекс города назначения
*'''townto''' - Город назначения
*'''addressto''' - Адрес назначения
*'''pvz''' - Код пункта самовывоза по [[#Справочник пунктов самовывоза|справочнику]]
*'''l''' - Длина в сантиметрах (не обязательный параметр)
*'''w''' - Ширина в сантиметрах (не обязательный параметр)
*'''h''' - Высота в сантиметрах (не обязательный параметр)
*'''mass''' - Масса в килограммах
*'''service''' - Режим доставки - число, указывающее на запись в справочнике [[#Справочник Видов срочности|видов срочности]]. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
*'''price''' - Сумма наложенного платежа
*'''inshprice''' - Сумма объявленной ценности
*'''paytype''' - Тип оплаты

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

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

'''Пример ответа стоимости доставки:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<calculator>
<calc>
<townfrom code="1">Москва город</townfrom>
<townto code="56603">Иркутск город</townto>
<mass>3.7</mass>
<service name="Экспресс">1</service>
<zone>2</zone>
<price>1163</price>
<mindeliverydays>1</mindeliverydays>
<maxdeliverydays>3</maxdeliverydays>
<mindeliverydate>2020-05-13</mindeliverydate>
<deliveryprice>
<advprice code="1" price="1000">База</advprice>
<advprice code="4" price="100">Процент от суммы руб</advprice>
<advprice code="5" price="63">Процент от объявленной стоимости</advprice>
</deliveryprice>
</calc>
</calculator>
</source>

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

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

== Получение информации о клиенте ==

'''Пример запроса получения информации о клиенте:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<client>
<auth extra="8" login="test" pass="testm" />
</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>
</source>

*'''code''' - Код записи.
*'''ordercode''' - Код заказа.
*'''orderno''' - Шифр заказа.
*'''orderdate''' - Дата заказа.
*'''delivereddate''' - Дата доставки.
*'''company''' - Получатель.
*'''price''' - Стоимость услуг.
*'''rur''' - Сумма заказа.
*'''inshprice''' - Стоимость заказа.
*'''pricekur''' - Стоимость курьерской доставки.
*'''priceag''' - Агентское вознаграждение.
*'''pricecalc''' - Сумма для передачи агенту.
*'''paytype''' - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
*'''paytypename''' - Строковое представление типа оплаты
*'''weight''' - Вес заказа.
*'''distance''' - Дистанция по заказу
*'''status''' - Статус заказа.

== Генерация коротких ссылок ==

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

'''Пример запроса генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
<link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>
</source>

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

'''Пример ответа на запрос генерации коротких ссылок:'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
<hash>35AF350C</hash>
</shortlink>
</source>

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

Далее, можно использовать ссылку на ЛК:

<nowiki>https://home.courierexe.ru/35AF350C или curie.ru/35AF350C</nowiki>

'''Примечание!''' Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

== Проверка надежности покупателя ==

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

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<auth extra="8" login="login" pass="pass" />
<phones>
<phone>89161147992</phone>
</phones>
</mcheck>
</source>

Ответ:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8" ?>
<mcheck>
<phones>
<phone rate="90">89161147992</phone>
</phones>
</mcheck>
</source>