API — различия между версиями

Версия 07:20, 28 сентября 2020

ВНИМАНИЕ! Изменения для 54-ФЗ!

Для передачи ставки НДС при оформлении заказа добавлен атрибут items -> item -> VATrate.

При использовании услуги кассового обслуживания необходимо в обязательном порядке передавать состав заказа со ставками НДС!

ВНИМАНИЕ!

В ближайшем будущем, при подключенной услуге кассового обслуживания, система перестанет принимать заказы без состава вложений!

English version is HERE!

В системе "Курьерская служба 2008" имеется возможность интеграции средствами XML API, по протоколу HTTP POST.

Данное API предназначено для интеграции клиентов (интернет-магазинов и прочих компаний-заказчиков доставки) с курьерскими службами, работающими под управлением системы MeaSoft "Курьерская служба 2008". Если Вы являетесь агрегатором, передающим данные от клиентов, возможно, Вам придется последовательно подключаться под разными пользователями, если курьерская служба должна вести раздельный учет взаиморасчетов по клиентам. Если Вы являетесь подрядчиком - Вы можете забирать заказы, используя значение client=AGENT в запросе statusreq, и передавать статусы заказов используя метод setorderinfo. Так же для интеграций с подрядчиками у нас есть специальная платформа, но добавлять подрядчиков в нее можно только на нашей стороне. Присылайте нам коммерческое предложение, описание Вашего сервиса, и мы с радостью его рассмотрим.

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

Если у Вас, после прочтения данной документации остались вопросы, Вы можете их задать по почте support@courierexe.ru. Обязательно представьтесь, напишите Ваши контактные данные (телефон, скайп) и название компании, с которой Вы хотите интегрироваться.

Содержание

1 Готовые интеграции
2 Тестовый аккаунт
3 Рабочий аккаунт для подключения
4 Общие понятия
5 Ограничения
6 Оформление заказа
- 6.1 Пример оформления заказа
- 6.2 Описание элементов для оформления заказа
- 6.3 Примеры ответов
7 Запрос статуса заказов
- 7.1 Пример запроса статуса заказа
- 7.2 Описание полей запроса статуса
- 7.3 Примеры ответов
- 7.4 Описание полей ответа статусов
- 7.5 Передача только изменившихся статусов
8 Трекинг заказа по номеру
9 Изменение заказа
- 9.1 Описание полей запроса изменения
- 9.2 Описание полей ответа изменения
10 Отмена заказа
11 Добавление вложений к накладной
12 Получение вложений к накладной
13 Изменение статуса агентом
14 Получение документов для печати
15 Справочник городов
16 Справочник регионов
17 Справочник улиц
18 Справочник номенклатуры
19 Движение номенклатуры
20 Справочник филиалов
21 Справочник пунктов самовывоза
22 Получение фискальных данных заказа
23 Справочник Видов срочности
24 Справочник дополнительных услуг
25 Расчет стоимости доставки
26 Список актов передачи денег
27 Детализация актов передачи денег
28 Генерация коротких ссылок

Готовые интеграции

Для интеграции с популярными CMS можно скачать модули интеграции

Система управления контентом (CMS)	Ссылка	Примечание
	Установить	Поддерживает версии 14.5 и выше
	Скачать	Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
	Скачать для версии 1.5.5.1 Скачать для версии 2.0 Скачать для версии 2.3 Скачать для версии 3.0	Поддерживает версии с 1.5.5.1. Скачивайте модули для своей версии OpenCart Альтернативный модуль сторонних разработчиков
	Установить модуль Установить плагин	Модуль предназначен для отправки заявок в КС, а плагин для расчета стоимости доставки при оформлении заказа.
	Сайт компании PROMO	Компания PROMO разработала этот модуль и настраивает интеграцию КС 2008 с ADVANTSHOP своим клиентам.
	Установить	Настраивается в ЛК пользователя в системе
		Настраивается в ЛК пользователя в системе Leadvertex
	RetailCRM	Настраивается в ЛК пользователя в системе
	-	Альтернативный модуль сторонних разработчиков
	Скачать	Работает только с компонентом Virtuemart. Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
	Установить	Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!
	Подключение Инструкция
	Скачать Инструкция	Внимание! Модуль новый, поэтому возможна некорректная передача данных. Проверяйте, если что - сообщайте, исправим!

Форма отправки заказа

Обратите внимание! В модулях систем PrestaShop, OpenCart, OCStore, Webasyst, InSales и Joomla для отправки заказа в курьерскую службу необходимо зайти в карточку заказа, в которой должна отображаться форма (см. изображение). Форма позволяет отправить заказ, а если заказ отправлен - проверить его статус.

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

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

Тестовый аккаунт

Для отладки Вы можете зайти в тестовый личный кабинет по адресу https://home.courierexe.ru/8, логин: test пароль: testm. Там на закладке "Автоматизация" Вы сможете увидеть свои запросы "глазами" нашей системы. Так же там есть интерфейс для выполнения запросов. На закладке "Отслеживание" Вы увидите созданные заказы.

Для упрощения интеграции можно скачать пример обращения к сервису на PHP.

Рабочий аккаунт для подключения

Для подключения к площадке Вашего клиента необходимо иметь три параметра:

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

2. Логин - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке "Прочее" в поле "Имя пользователя". Возможно, что в программе КС2008 понадобится создать новую карточку клиента (на скриншоте ниже).

3. Пароль - параметр учетной записи для ЛК клиента и API, указывается в карточке клиента на вкладке "Прочее" в поле "Пароль" (на скриншоте ниже).

Общие понятия

На стороне курьерской службы имеется веб-сервис по адресу: https://home.courierexe.ru/api/. Еще есть порт 8443.

Тестовые авторизационные данные: логин: test пароль: testm, параметр extra: 8. Обратите внимание, что тестовая площадка для всех одна. Не нужно передавать в нее заказы с конфиденциальными данными, их смогут увидеть другие участники.

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

Клиент отправляет запросы к сервису, методом HTTP POST, сервис обрабатывает запросы и возвращает результат выполнения. Все запросы и ответы передаются в формате XML. Кодировка - UTF-8. Разделитель целой и дробной частей чисел - используется символ точки. Даты представляются в виде YYYY-MM-DD, время - HH:MM. В силу особенностей языка XML, некоторые символы в тексте должны быть заменены: & на & < на < > на > " на "

Наше API принципиально работает только по HTTPS, т.к. передает конфиденциальные данные. В некоторых системах с этим возникают проблемы. Если ваша система не может полноценно работать с шифрованием, мы рекомендуем развернуть http-сервер у себя локально, установить прокси на PHP. Как запустить

Ограничения

С целью защиты от не целевого использования сервисов, а так же от DDoS-атак, действуют следующие ограничения:

150 запросов с одного IP-адреса за 1 минуту
1500 запросов с одного IP-адреса за 20 минут
3000 запросов с одного аккаунта за 1 час
200 Мб скачанных текстовых данных за 3 часа

В случае превышения блокируется IP-адрес или аккаунт на время до 3-х часов.

Чтобы не происходило блокировок:

Не нужно "бомбить" наше API запросами статусов последовательно перебирая номера всех ваших заказов, особенно - запросами "tracking", они предназначены не для этого (смотрите описание). Особенно ровно в 0 минут каждого часа.
Не нужно каждые 5 минут делать запросы "Покажите статусы всех заказов за последние 3 месяца".
Для проверки статусов заказов лучше всего использовать запросы измененных статусов changes=ONLY_LAST.
При запросе измененных статусов ОБЯЗАТЕЛЬНО нужно подтверждать успешное получение запросом commitlaststatus

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

Оформление заказа

Пример оформления заказа

<?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>Чип &amp; Дейл</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>
     <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>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" article="1" volume="3" origincountry="AUT" GTD="321546654" excise="15.20" suppcompany="ООО &quot;Рога и копыта&quot;" 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" 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">
      <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>

Описание элементов для оформления заказа

neworder - Корневой контейнер, обязательный элемент.

newfolder - Признак нового заказа YES/NO. Если стоит YES, то в системе курьерской службы для данной корреспонденции создастся новый заказ. Необязательный элемент.

order - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере neworder может быть много контейнеров order для создания нескольких заказов одним запросом.

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

barcode - Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.

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

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

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

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

   <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>
     <coords lat="55.680327" lon="37.604456"></coords>
   </receiver>

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

Для тега города town можно указать код региона в атрибуте regioncode из справочника регионов. Поиск будет производиться в указанном регионе.

Также можно указать страну получателя в атрибуте country в соответствии с стандартом ISO_3166-1, например, "RU", "RUS" или "643" для России.

Кроме того, поиск города осуществляется с учетом почтового индекса, указанного в теге zipcode.

Поле Город контейнеров sender и receiver можно указать одним из следующих способов:

код населенного пункта из справочника городов
13-ти значный код адресного классификатора КЛАДР
36-ти значный код адресной системы ФИАС
Федеральная информационная адресная система — единый российский государственный адресный реестр
(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, в него будет добавлено вложение "Доставка".
return - Признак необходимости возврата.
return_service - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
discount - Сумма скидки. Скидка "размазывается" по товарным вложениям, сумма НП уменьшается на сумму скидки. При этом вложение Скидка не создается. ВНИМАНИЕ, при использовании этого тега общая сумма может расходиться на копейки из-за округления! Старайтесь не использовать этот тег, а указывать цену товаров уже с учетом скидок.
enclosure - Вложение.
inshprice - Объявленная ценность. Если явно не указана сумма - автоматически считается как сумма по товарам.
instruction - Поручение - Примечание.
courier - Запланированный курьер. Согласно коду курьера в КС2008.
receiverpays - Признак оплаты стоимости доставки - услуг службы доставки получателем, а не заказчиком YES/NO.
department - Подразделение, в котором оформляется заказ.
pickup - Признак оформления забора YES/NO. Если стоит YES, то весь заказ считается заданием на забор груза, а не на доставку! Применяется для вызова курьера к отправителю для забора других отправлений.
acceptpartially - Признак возможности частичного выкупа товаров отправления YES/NO.

items - Контейнер для описания вложений. Необязательный контейнер. Атрибуты:

item - Название вложения.
quantity - Количество единиц товара.
mass - Масса единицы товара в килограммах.
volume - Объемный вес единицы товара в килограммах. При указании объемного веса значение подставляется вместо массы
length - Длина единицы товара (в сантиметрах).
width - Ширина единицы товара (в сантиметрах).
height - Высота единицы товара (в сантиметрах).
retprice - Цена единицы товара. Округляется до копеек. Должна быть с учетом всех скидок и наценок. Для вложений типов 1, 2, 3 не может быть отрицательной.
inshprice - Объявленная ценность единицы товара. Округляется до копеек. Если не указана принимается равной retprice.
VATrate - Ставка НДС - целое число процентов. Если значение не указано, подставляется значение "20". Значение "0" означает ставку "Без НДС", ставка "0%" на данный момент не поддерживается.
barcode - Штрих-код вложения.
article - Артикул вложения. Внимание! Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к справочнику номенклатуры. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если по артикулу найдено несколько товаров - система выберет один из них случайным образом, что может привести к ошибочной комплектации! Если товар НЕ на ответственном хранении - артикул указывать НЕ нужно. Позиция попадет в систему просто текстом.
type - Тип вложения. Принимает значения:

1 - Товар. По-умолчанию.

2 - Доставка. Такое вложение добавится автоматически, если заполнить order->deliveryprice

3 - Услуга

4 - Предоплата. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе. Такое вложение добавится автоматически при указании order->paytype=NO.

6 - Оплата кредитом. Указывается сумма. Поле quantity игнорируется, всегда "1". В заказе сумма будет отрицательной независимо от знака в запросе.

7 - Забор товара. Если товар нужно у получателя забрать, возможно - вернуть деньги, или его стоимость вычтется из суммы других товаров. У такого товара в заказе будет отрицательное количество независимо от знака в запросе.

extcode - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Необязательное поле.
origincountry - Код страны-производителя в соответствии со стандартом 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 - стоимость в случае возврата заказа

below - граница стоимости настроек

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

advprices - Контейнер для описания дополнительных услуг. Необязательный

code - код услуги
value - значение услуги. Если тип услуги bool, то в значении передаем true

costcode - Кост-код сотрудника.

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

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

Примеры ответов

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

Пример успешного ответа

<?xml version="1.0" encoding="UTF-8"?>
<neworder>
   <createorder orderno="AB23541" error="0" errormsg="success"></createorder>
   <createorder orderno="55_6542" error="0" errormsg="success"></createorder>
   <createorder orderno="AB23542" error="0" errormsg="success"></createorder>
</neworder>

Пример ответа с ошибкой

<?xml version="1.0" encoding="UTF-8"?>
<neworder>
   <createorder orderno="AB23541" error="17" errormsg="Such number exists"></createorder>
   <createorder orderno="AB23542" error="13" errormsg="empty company"></createorder>
   <createorder orderno="AB23543" error="14" errormsg="empty person"></createorder>
</neworder>

Пример ответа при ошибке авторизации

<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>

Пример ответа при ошибке синтаксиса

<?xml version="1.0" encoding="UTF-8"?>
<request>
   <error>column:1 line:11 message:expected '>'</error>
</request>

Запрос статуса заказов

Пример запроса статуса заказа

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

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

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

auth - Авторизация. Обязательный элемент.
client - Признак клиента или агента. Необязательный элемент.

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

orderno - Номер заказа. Необязательный элемент.
ordercode - Внутренний код заказа. Необязательный элемент.
orderno2 - Номер заказа из срочных. Необязательный элемент.
datefrom - Дата заказа "с". Необязательный элемент.
dateto - Дата заказа "по". Необязательный элемент.
target - Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.
done - Может принимать значения:

ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, Доставлен или Частично доставлен)
ONLY_NOT_DONE - Только не доставленные (заказы, которые не являются доставленными, например, Не доставлен или Утерян)
ONLY_NEW - Только новые
ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т.д.
Пусто - все корреспонденции

changes - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются. Описание данного режима приведено здесь: Передача только изменившихся статусов

Обратите внимание!

Периода запроса статусов (контейнеры datefrom и dateto) ограничивается двумя месяцами — два месяца до даты "по".
Если не указаны обе даты — dateto принимается равной текущей дате.
Если не указана дата dateto — она принимается равной datefrom плюс 2 месяца.
Если не указана дата datefrom — она принимается равной dateto минус 2 месяца.

Примеры ответов

Пример успешного ответа

<?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>
   </receiver>
   <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>
   <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>
   <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>
   <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>

Пример ответа если нет заказов

<?xml version="1.0" encoding="utf-8"?>
<statusreq count="0">
</statusreq>

Пример ответа при ошибке авторизации

<?xml version="1.0" encoding="utf-8"?>
<request>
<error error="1" errormsg="authorization error"></error>
</request>

Пример ответа при ошибке синтаксиса

<?xml version="1.0" encoding="UTF-8"?>
<request>
   <error>column:1 line:11 message:expected '>'</error>
</request>

Описание полей ответа статусов

Все поля ответа соответствуют структуре order при создании заказа, с некоторыми добавлениями:

Атрибуты контейнера order:

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

атрибут code контейнера item - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.

returns - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

атрибут got контейнера package - признак принятого места YES / NO.

returns - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.

coords в контейнере receiver - координаты получателя.
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 создания записи о смене статуса в БД. Используется для сортировки записей, чтобы соблюсти хронологическую последовательность. Подробнее

message - наименование филиала-получателя, при передаче между филиалами
title - русское наименование статуса

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

Значения контейнеров status могут принимать следующие значения:

AWAITING_SYNC - Ожидает синхронизации. Данные заказа пока не появились в бэкофисе

NEW - Новый

PICKUP - Забран у отправителя

ACCEPTED - Получен складом

INVENTORY - Инвентаризация

DEPARTURING - Планируется отправка

DEPARTURE - Отправлено со склада

DELIVERY - Выдан курьеру на доставку

COURIERDELIVERED - Доставлен (предварительно)

COMPLETE - Доставлен

PARTIALLY - Доставлен частично

COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.

CANCELED - Не доставлен (Возврат/Отмена)

RETURNING - Планируется возврат

RETURNED - Возвращен

WMSASSEMBLED - Скомплектован на складе

WMSDISASSEMBLED - Разукомплектован

CONFIRM - Согласована доставка

DATECHANGE - Перенос

NEWPICKUP - Создан забор

UNCONFIRM - Не удалось согласовать доставку

PICKUPREADY - Готов к выдаче

LOST - Утрачен/утерян

COURIERPARTIALLY - Частично со слов курьера

COURIERCANCELED - Отказ со слов курьера

Примечание: В будущем возможно расширение и изменение используемого набора статусов.

Обратите внимание!

Атрибуты контейнера status заполняются для версий системы 2008.0.0.670 и новее.
Контейнер statushistory заполняется для тарифа "Премиум" и версий системы 2008.0.0.670 и новее.
Контейнер deliveryprice заполняется для тарифа "Премиум".

Передача только изменившихся статусов

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

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

<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
  <auth extra="8" login="login" pass="pass"></auth>
  <changes>ONLY_LAST</changes>
</statusreq>

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

orderno
status
delivereddate
deliveredtime
deliveredto
receiver->date
receiver->address
price

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

<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus>
  <auth extra="8" login="login" pass="pass"></auth>
  <client>CLIENT</client>
</commitlaststatus>

Описание полей запроса

auth - Авторизация. Обязательный элемент.
client - Признак клиента или агента. Необязательный элемент.

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

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

<?xml version="1.0" encoding="UTF-8" ?>
<commitlaststatus error="0">OK</commitlaststatus>

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

Обратите внимание!

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

Трекинг заказа по номеру

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

Пример запроса:

<?xml version="1.0" encoding="UTF-8"?>
<tracking>
  <extra>8</extra>
  <orderno>1234</orderno>
</tracking>

Пример ответа:

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

Получение информации в формате 17 TRACK

Пример запроса:

<?xml version="1.0" encoding="UTF-8"?>
<tracking17>
  <extra>8</extra>
  <orderno>1234</orderno>
</tracking17>

Пример ответа:

{
	"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"
		}
	]
}

Функция ищет последний заказ по номеру среди заказов всех клиентов. Выдает неперсонализированную информацию о текущем состоянии заказа.
Описание контейнеров ответа аналогично описанию Запроса статусов заказов.

Изменение заказа

Запрос предназначен для изменения заказов, находящихся в статусах "Ожидает синхронизации" или "Новый", а также по которым не было произведено изменений - статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе.

Обратите внимание!

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

Описание полей запроса изменения

Все поля запроса соответствуют структуре order при создании заказа за исключением:

вместо корневого тэга neworder указывается editorder
тэг штрих-кода barcode не указывается, поскольку присваивается при создании заказа.

Описание полей ответа изменения

Все поля ответа соответствуют ответу при создании заказа за исключением корневого тэга - вместо neworder возвращается editorder.

Отмена заказа

Запрос отмены предназначен для отмены тех заказов, по которым не было произведено изменений - статуса доставки, статуса корреспонденции, времени доставки - то есть заказов, которые ещё не находятся в работе. Возможность отмены заказа есть только у курьерских служб с тарифом "Премиум" и по-умолчанию она выключена, ее нужно отдельно включить: Личный кабинет курьерской службы#Дополнительные настройки.

При отмене заказа поле "Инфо о доставке" получает значение "Отменено заказчиком", поле "Дата доставки" - текущую дату, а "Вручил курьер" - системную запись "ОТМЕНА".

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

<?xml version="1.0" encoding="UTF-8" ?>
<cancelorder>
  <auth extra="8" login="login" pass="pass" />
  <order orderno="" ordercode="123456" />
  <order orderno="123aaa" ordercode="" />
</cancelorder>

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

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

auth - Авторизация. Обязательный элемент.
order - Контейнер отменяемого заказа. Обязательный элемент. Запрос может содержать более одного контейнера order. Атрибуты:

orderno - Шифр заказа.
ordercode - Внутренний код заказа.

Обратите внимание, что должен быть указан хотя бы один из атрибутов orderno или ordercode!

Пример ответа:

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

Добавление вложений к накладной

Пример запроса:

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

Описание полей:

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

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

Пример ответа:

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

Получение вложений к накладной

Пример запроса:

<?xml version="1.0" encoding="UTF-8" ?>
<attachments>
  <auth extra="8" login="login" pass="pass" />
  <orderno>1234567</orderno>
</attachments>

Описание полей:

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

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

Пример ответа:

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

В тегах item возвращаются бинарные данные (файлы), закодированные в base64.

Изменение статуса агентом

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

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

При необходимости к заказу можно прикрепить изображения.

Пример запроса изменения статуса:

<?xml version="1.0" encoding="UTF-8" ?>
<setorderinfo>
  <auth extra="8" login="login" pass="pass" />
  <order ordercode="123456">
    <message>Получил Иванов</message>
  </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>

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

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

auth - Авторизация. Обязательный элемент.
order - Контейнер заказа. Обязательный элемент. Запрос может содержать более одного контейнера order. Атрибут ordercode - внутренний код заказа.
status - Новый статус заказа. Доступны статусы из раздела #Описание полей ответа статусов, кроме AWAITING_SYNC и NEW.
eventtime - Дата и время изменения статуса. Обязательно при указании статуса.
message - Текст сообщения Инфо о доставке.
paytype - Тип оплаты заказа. Допустимые значения CASH/CARD.
items - Контейнер для описания вложений item . Атрибуты:

code - Код вложения.
quantity - Количество доставленных единиц вложения.
reason - Причина недоставки, выбирается из соответствующего списка статусов.

image - Контейнер прикрепляемого изображения. Содержит текст файла изображения, закодированный по стандарту base64. Контейнер order может содержать более одного контейнера image. Атрибут:

filename - Имя файла.

Пример ответа:

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

Получение документов для печати

Пример запроса получения печатных форм:

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

Описание полей:

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

auth - Авторизация. Обязательный элемент
orders - Список заказов для получения печатных форм. Содержит тэги order с атрибутами:

orderno - шифр заказа
ordercode - внутренний код заказа. Указывать необходимо один из атрибутов для всех заказов. Приоритет имеет атрибут ordercode

form - Формат накладной. Не обязательный элемент. Принимает значения:

1 - Подробная накладная (по-умолчанию)
2 - Наклейки Zebra
3 - Наклейки на страницу формата А4
4 - Акты приема-передачи

Пример ответа:

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

В тэге content возвращаются бинарные данные (файл pdf), закодированные в base64.

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

Справочник городов

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

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

Внутри контейнера 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.

Пример ответа:

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

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

Справочник регионов

Пример запроса справочника:

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

Пример ответа:

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

Справочник улиц

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

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

conditions - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".

town - Обязательное поле. Название или код населенного пункта.
namecontains - Поиск населенных пунктов, название которых содержит указанный текст.
namestarts - Поиск населенных пунктов, название которых начинается с указанного текста.
name - Поиск населенных пунктов, название которых соответствует указанному тексту.
fullname - Поиск населенных пунктов, название вместе с типом населенного пункта которых соответствует указанному тексту.

limit - Ограничивает вывод результата.

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

Пример ответа:

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

В ответе улицы сортируются по алфавиту.

Справочник номенклатуры

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

<?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>
    <limit>
      <limitfrom>30</limitfrom>
      <limitcount>10</limitcount>
      <countall>YES</countall>
    </limit>
</itemlist>

Внутри контейнера itemlist все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

codesearch - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.

code - Поиск по внутреннему коду системы.
article - Поиск по артикулу.
barcode - Поиск по штрих-коду.

conditions - Задает условия поиска. Все вложенные элементы одновременно накладывают условие "И".

namecontains - Поиск товаров, название которых содержит указанный текст.
namestarts - Поиск товаров, название которых начинается с указанного текста.
name - Поиск товаров, название которых соответствует указанному тексту.
quantity - Наличие на складе. Принимает значения EXISTING_ONLY - Только в наличии, NOT_EXISTING_ONLY - Только не в наличии, ALL - Все. Это поле может быть недоступным в некоторых установках.
store - Поиск товаров по определенному складу.

limit - Ограничивает вывод результата.

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

Пример ответа:

<?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>
    <CountInPallet>30</CountInPallet>
    <HasSerials>1</HasSerials>
    <CountryOfOrigin>Малайзия</CountryOfOrigin>  (not yet supported)
    <Message>Хороший телевизор</Message>
    <Message2>Снова хороший телевизор</Message2>
    <quantity>12</quantity>
    <reserved>3</reserved>
  <item>
  ...
</itemlist>

Описание полей:

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

Движение номенклатуры

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

<?xml version="1.0" encoding="UTF-8" ?>
<itemmovements>
 <auth extra="8" login="login" pass="pass"></auth>
 <code>4259</code>
</itemmovements>

code - внутренний код товара в справочнике номенклатуры.

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

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

Описание полей ответа

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 - номер документа
date - дата документа
message - комментарий

Справочник филиалов

Пример запроса списка филиалов:

<?xml version="1.0" encoding="UTF-8" ?>
<storelist>
 <auth extra="8"></auth>
 <json>YES</json>
</storelist>

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

Пример ответа:

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

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

Справочник пунктов самовывоза

Для отображения списка пунктов выдачи (ПВЗ) есть готовый JavaScript модуль: https://home.courierexe.ru/js/measoft_map.js Инструкция по использованию - внутри.

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

<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
 <auth extra="8" login="login" pass="pass"></auth>
 <code>1234</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>
</pvzlist>

auth - Атрибут extra - обязателен, по нему определяется курьерская служба, login и pass позволяют авторизоваться под клиентом: для отдельного клиента могут быть ограничения по доступности некоторых ПВЗ, и в этом случае они будут учтены.
code - Внутренний код.
town - Город получателя.
parentcode - Фильтр по родительскому элементу
acceptcash - Фильтр по приему наличных YES/NO
acceptcard - Фильтр по приему банковских карт YES/NO
acceptfitting - Фильтр по наличию примерки YES/NO
maxweight - Фильтр по максимальному весу, с которым работает ПВЗ
acceptindividuals - Фильтр по доступности физическим лицам YES/NO
lt - Широта левого верхнего угла
lg - Долгота левого верхнего угла
rt - Широта правого нижнего угла
rg - Долгота правого нижнего угла
json - Признак вывода ответа в виде JSON YES/NO

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

<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
  <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>
  </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>
  </pvz>
</pvzlist>

code - Код ПВЗ в системе. Используется в запросе оформления заказов
clientcode - Код ПВЗ используемый компанией-подрядчиком.
name - Наименование ПВЗ.
parentcode - Код родительского элемента.
parentname - Наименование родительского элемента.
town - Населенный пункт с кодом из справочника городов, а также с кодом и наименованием региона.
address - Адрес ПВЗ.
phone - Телефоны ПВЗ.
comment - Дополнительная информация.
worktime - Режим работы ПВЗ.
traveldescription - Описание местонахождения ПВЗ или пути к нему.
maxweight - Максимальный вес, с которым работает ПВЗ.
acceptcash - Признак приема наличных
acceptcard - Признак приема банковских карт
acceptfitting - Наличие примерки
latitude - Широта
longitude - Долгота

Получение фискальных данных заказа

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

<?xml version="1.0" encoding="UTF-8"?>
<receiptdata>
   <auth extra="8" login="test" pass="testm" />
   <orders>
      <order orderno="123456" />
      <order orderno="890111C" />
   </orders>
</receiptdata>

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

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

Параметры ответа:

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

item - код товара
name - наименование товара
qty - количество товара
price - цена товара
governmentCode - считанная последовательность, которая в дальнейшем преобразуется по алгоритму тега 1162
vatRate - НДС товара
itemType - тип товара (товар, доставка и т.д.)

Справочник Видов срочности

Пример запроса Видов срочности:

<?xml version="1.0" encoding="UTF-8" ?>
<services>
<auth extra="8"/>
</services>

Пример ответа справочника Видов срочности:

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

Справочник дополнительных услуг

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

<?xml version="1.0" encoding="UTF-8"?>
<advprices>
   <auth extra="8" login="login" pass="pass" />
   <visible>NO</visible>
</advprices>

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

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

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

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

Параметры:

code - внутренний код услуги
name - наименование услуги. Если поле "название в ЛК" в настройках услуги не пусто, то возвращает значение поля "название в ЛК".
hine - подсказка по доп услуге для пользователя
type - тип услуги. Может иметь значения:

bool - для услуг вида "чекбокс", "Да"
float - для числа с плавающей точкой
int - для целого числа

Расчет стоимости доставки

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

<?xml version="1.0" encoding="UTF-8" ?>
<calculator>
  <auth extra="8" login="login" pass="pass" />
  <calc townfrom="Москва" 
	addressfrom="Ленинский проспект, 95"
	zipcode="664000"
	townto="3800000300000"
	addressto="Ленина ул., 10"
	l="10"
	w="20"
	h="30"
	mass="3.7"
	service="1"
	price="1200"
	inshprice="1200"
	paytype="CASH" />
</calculator>

Параметры:

townfrom - Город отправления
addressfrom - Адрес отправления
zipcode - Почтовый индекс города назначения
townto - Город назначения
addressto - Адрес назначения
l - Длина в сантиметрах (не обязательный параметр)
w - Ширина в сантиметрах (не обязательный параметр)
h - Высота в сантиметрах (не обязательный параметр)
mass - Масса в килограммах
service - Режим доставки - число, указывающее на запись в справочнике видов срочности. Если этот параметр опустить, система выдаст расчет для всех доступных видов срочности, передав много контейнеров <calc> в ответе.
price - Сумма наложенного платежа
inshprice - Сумма объявленной ценности
paytype - Тип оплаты

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

В авторизации можно опустить параметры login и pass, тогда расчет будет производиться по стандартному тарифу курьерской службы, без учета возможных отличий для конкретного клиента.
Объемный вес будет учитываться только при условии указания всех габаритов: длины, ширины и высоты.
В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР, либо 36-ти значный код адресной системы ФИАС (AOID).

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

<?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>
  </calc>
</calculator>

Параметры:

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

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

Список актов передачи денег

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

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

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

auth - Авторизация. Обязательный элемент.
datefrom - Дата "с". Необязательный элемент.
dateto - Дата "по". Необязательный элемент.

Если интервал дат не указан, то возвращаются акты передачи денег за последний месяц.

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

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

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

Детализация актов передачи денег

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

<?xml version="1.0" encoding="UTF-8" ?>
<smadetail>
  <auth extra="8" login="login" pass="pass" />
  <code>6278</code>
</smadetail>

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

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

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

<?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>
    <status>Доставлено</status>
  </specialsma>
</smadetail>

code - Код записи.
ordercode - Код заказа.
orderno - Шифр заказа.
orderdate - Дата заказа.
delivereddate - Дата доставки.
company - Получатель.
price - Стоимость услуг.
rur - Сумма заказа.
inshprice - Стоимость заказа.
pricekur - Стоимость курьерской доставки.
priceag - Агентское вознаграждение.
pricecalc - Сумма для передачи агенту.
paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
paytypename - Строковое представление типа оплаты
status - Статус заказа.

Генерация коротких ссылок

В некоторых случаях, например, при использовании в СМС, может потребоваться использование коротких ссылок на ЛК. Для этого, необходимо отправить запрос с полной ссылкой, в ответ на который придёт хэш-код для ссылки.

Пример запроса генерации коротких ссылок:

<?xml version="1.0" encoding="UTF-8" ?>
<shortlink>
  <link short="0"> https://home.courierexe.ru/8/site/orders </link>
</shortlink>

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

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

Пример ответа на запрос генерации коротких ссылок:

<?xml version="1.0" encoding="UTF-8"?>
<shortlink>
  <hash>35AF350C</hash>
</shortlink>

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

Далее, можно использовать ссылку на ЛК:

https://home.courierexe.ru/35AF350C или curie.ru/35AF350C

Примечание! Сервис коротких ссылок работает только для ресурсов компании MeaSoft.

@@ Строка 380: / Строка 380: @@
 *'''costcode''' - Кост-код сотрудника.
-*'''overall_volume''' - Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина см, если во всех местах есть пустые значения.
+*'''overall_volume''' - Общий объем, м3. Виртуальное поле. Необязательное. Из этого поля рассчитывается длина/высота/ширина места. Расчет срабатывает только если в каждом месте есть нулевые значения длины или высоты или ширины.
 В случае необходимости указания, помимо товаров, дополнительных услуг (например, ДОСТАВКА, комплектация, подъем на этаж и т.д.) - их нужно указать в том же контейнере items как товары, без артикула.

API — различия между версиями

Версия 07:20, 28 сентября 2020

Содержание

Готовые интеграции

Тестовый аккаунт

Рабочий аккаунт для подключения

Общие понятия

Ограничения

Оформление заказа

Пример оформления заказа

Описание элементов для оформления заказа

Примеры ответов

Запрос статуса заказов

Пример запроса статуса заказа

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

Примеры ответов

Описание полей ответа статусов

Передача только изменившихся статусов

Трекинг заказа по номеру

Изменение заказа

Описание полей запроса изменения

Описание полей ответа изменения

Отмена заказа

Добавление вложений к накладной

Получение вложений к накладной

Изменение статуса агентом

Получение документов для печати

Справочник городов

Справочник регионов

Справочник улиц

Справочник номенклатуры

Движение номенклатуры

Справочник филиалов

Справочник пунктов самовывоза

Получение фискальных данных заказа

Справочник Видов срочности

Справочник дополнительных услуг

Расчет стоимости доставки

Список актов передачи денег

Детализация актов передачи денег

Генерация коротких ссылок

Навигация

Поиск