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

Материал из Меасофт
Перейти к: навигация, поиск
(→‎Расчет стоимости доставки)
Строка 941: Строка 941:
 
<calculator>
 
<calculator>
 
   <auth extra="8" login="login" pass="pass" />
 
   <auth extra="8" login="login" pass="pass" />
−
   <calc townfrom="Москва город" townto="Воронеж город" mass="3.7" mode="2" />
+
   <calc townfrom="Москва" townto="3800000300000" mass="3.7" mode="1" />
 
</calculator>
 
</calculator>
 
</source>
 
</source>
 +
 +
Параметры:
 +
*'''townfrom''' - Город-отправитель
 +
*'''townto''' - Город-получатель
 +
*'''mass''' - Масса в килограммах
 +
*'''mode''' - Режим доставки - число, указывающее на запись в справочнике [Справочник Видов срочности|видов срочности]
 +
 +
В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР.
 +
 +
  
 
'''Пример ответа стоимости доставки:'''
 
'''Пример ответа стоимости доставки:'''
 
<source lang="xml">
 
<source lang="xml">
−
<?xml version="1.0" encoding="UTF-8" ?>
+
<?xml version="1.0" encoding="UTF-8"?>
 
<calculator>
 
<calculator>
−
   <calc townfrom="Москва город" townto="Воронеж город" mass="3.7" price="4080.43"/>
+
   <calc price="1163">
 +
    <townfrom code="1">Москва город</townfrom>
 +
    <townto code="56603">Иркутск город</townto>
 +
    <mass>3.7</mass>
 +
    <mode>1</mode>
 +
    <zone>2</zone>
 +
    <price>1163</price>
 +
    <maxdeliverydays>3</maxdeliverydays>
 +
  </calc>
 
</calculator>
 
</calculator>
 
</source>
 
</source>
 +
 +
Параметры:
 +
*атрибут '''price''' - рассчитанная стоимость доставки, оставлен для обратной совместимости, не рекомендуется к использованию!
 +
*'''townfrom''' - Город-отправитель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.
 +
*'''townto''' - Город-получатель так, как система его распознала и привязала к справочнику. Атрибут '''code''' - код из справочника городов системы.
 +
*'''mass''' - Масса в килограммах
 +
*'''mode''' - Режим доставки - число, указывающее на запись в справочнике видов срочности (см описание на этой странице).
 +
*'''zone''' - номер тарифной зоны, по которой рассчиталась стоимость. В зависимости от зоны выбирается тарифная сетка. Так же к цене могут применяться повышающие или понижающие коэффициенты при доставке не из/в региональный центр.
 +
*'''price''' - рассчитанная стоимость доставки. Рекомендуется к использованию в отличие от одноименного атрибута родительского контейнера.
 +
*'''maxdeliverydays''' - максимальный срок доставки в рабочих днях.
  
 
== Список актов передачи денег ==
 
== Список актов передачи денег ==

Версия 18:23, 1 сентября 2016

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

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

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

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

Система управления контентом (CMS) Версия модуля Ссылка Примечание
Bitrix.png
 1.5.5 от 01.06.2016 Скачать Unicode
Скачать ANSI 		Поддерживает версии 14.5 и выше
Prestashop.png
 1.3.1 от 01.06.2016 Скачать Поддерживает версии 1.5.2.0 и выше (2.x в том числе!)
Opencart.png
Ocstore.png
 1.6.1 от 01.06.2016 Скачать Поддерживает версии 1.5.5.1 и выше
Webasyst-shopscript.png
 1.2 от 05.05.2016 Установить
Insales.png
 1.0 от 08.02.2016 Установить

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

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

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

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

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

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

Extra1.png

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

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

33 client.png

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

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

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<neworder>
 <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>Санкт-Петербург</town>
     <address>Петровка 38 офис 35</address>
     <date>2014-03-22</date>
     <time_min>09:00</time_min>
     <time_max>14:00</time_max>
   </receiver>
   <return>NO</return>
   <return_service>1</return_service>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <paytype>CASH</paytype>
   <service>2</service>
   <price>387.5</price>
   <discount>0</discount>
   <inshprice>387.5</inshprice>
   <enclosure>Детские игрушки</enclosure>
   <instruction>Проверить при покупателе, подписать акт</instruction>
   <pvz>124</pvz>
   <otdel>Отдел</otdel>
   <items>
      <item extcode="abc123" quantity="1" mass="0.2" retprice="37.5" barcode="2345625213125" article="1">Мяч</item>
      <item extcode="abc124" quantity="2" mass="2" retprice="100" barcode="4645625213138" article="2">Обруч</item>
      <item extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3">Погремушка желтая</item>
   </items>
 </order>
</neworder>

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

  • neworder - Корневой контейнер, обязательный элемент.
  • order - Контейнер для описания одного заказа, обязательный элемент. В одном контейнере neworder может быть много контейнеров order для создания нескольких заказов одним запросом.
orderno - Номер заказа. Если присваивается клиентом - указывается здесь. Если не присваивается - можно оставить пустым, система сгенерирует свой номер, и вернет его в ответе.
  • barcode - Штрих-код заказа. В случае, если клиент штрих-кодирует свои отправления, и штрих-код отличается от номера заказа, в этом поле указывается штрих-код. В случае наличия нескольких мест, и раздельной их маркировки, в этом поле допустимы маски в виде символов подчеркивания, говорящие о позициях штрих-кода, переменных для разных мест в рамках одного заказа.

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

  • 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>Город получателя в формате "Москва город"</town>
     <address>Адрес получателя</address>
     <date>Дата доставки в формате "YYYY-MM-DD"</date>
     <time_min>Желаемое время доставки в формате "HH:MM"</time_min>
     <time_max>Желаемое время доставки в формате "HH:MM"</time_max>
   </receiver>
  • company - Компания-получатель.
  • person - Контактное лицо. Должно быть заполнено хотя бы одно из полей - company или person!
  • phone - Телефон. Можно указывать несколько телефонов, E-mail в этом поле.
  • town - Город. В системе города привязываются к справочнику, поэтому город должен иметь правильное полное написание. Так же можно в этом поле указать числовое значение - код населенного пункта из справочника городов. При указании названия возможно появление ошибки, если населенных пунктов с таким названием в справочнике несколько.
  • paytype - Тип оплаты заказа получателем. Принимает значения:
CASH - Наличными при получении (по-умолчанию)
CARD - Картой при получении
NO - Без оплаты. Поле Price будет проигнорировано. (Этот тип оплаты передается, если заказ уже оплачен и не требует инкассации, API добавит в систему товары по нулевой цене. Если необходимо передать общую сумму заказа - можно это сделать в поле <inshprice>, указав объявленную ценность)
OTHER - Прочее (Предусмотрен для того, чтобы оплата поступала непосредственно в курьерскую службу посредством прочих типов оплаты - таких как: вебмани, яденьги, картой на сайте, прочие платежные системы и т.д.)
OPTION - На выбор получателя. Этот тип оплаты нельзя передавать с заказом. Он выставляется автоматически в зависимости от настройки клиента.
  • zipcode - Почтовый индекс.
  • weight - Общий вес заказа в килограммах.
  • quantity - Количество мест.
  • service - Режим доставки (тип услуги) передается код из справочника "Виды срочности".
  • price - Сумма заказа. В случае наличия контейнера items значение данного параметра будет проигнорировано, и рассчитано автоматически.
  • discount - Скидка на заказ. В результате сумма заказа будет уменьшена на размер скидки.
  • return - Признак необходимости возврата.
  • return_service - Режим возврата (тип услуги) передается код из справочника "Виды срочности".
  • enclosure - Вложение.
  • inshprice - Объявленная ценность.
  • instruction - Поручение - Примечание.
  • pvz - Код пункта самовывоза. Коды ПВЗ можно узнать запросом или на закладке ПВЗ в личном кабинете клиента.
  • otdel - Подразделение, в котором оформляется заказ.
  • items - Контейнер для описания вложенных товаров. Не обязательный контейнер. Атрибуты:
item - Название товара.
quantity - Количество мест.
mass - Масса единицы товара в килограммах.
retprice - Цена единицы товара.
barcode - Штрих-код товара.
Article.png
article - Артикул товара. Внимание! Указание артикула используется только тогда, когда товар хранится на ответственном хранении в службе доставки, и необходима комплектация. В этом случае система пытается привязать товар к справочнику номенклатуры. Если товар в справочнике не найден - система выдаст соответствующую ошибку. Если товар не на ответственном хранении - артикул указывать не нужно. Позиция попадет в систему просто текстом.
extcode - Внешний код строки. Используется для идентификации строк заказов при получении статусов. Не обязательное поле. ПОКА НЕ ПОДДЕРЖИВАЕТСЯ.

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

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

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

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

Коды ошибок при оформлении заказа

0 - Ошибок нет.

1 - Ошибка авторизации. (отсутствуют теги <auth login="" pass=""></auth>, неверный логин или пароль).

2 - Отправлен пустой запрос (отсутствует контейнер <neworder></neworder> в XML документе).

3 - Некорректно указана сумма заказа.

4 - Некорректный общий вес заказа.

5 - Не найден город получатель.

6 - Не найден город отправитель.

7 - Не заполнен адрес получателя.

8 - Не заполнен телефон получателя.

9 - Не заполнено контактное имя получателя.

10 - Не заполнено название компании получателя.

11 - Некорректная сумма объявленной ценности.

12 - Артикул не найден.

13 - Не заполнено название компании отправителя.

14 - Не заполнено контактное имя отправителя.

15 - Не заполнен телефон отправителя.

16 - Не заполнен адрес отправителя.

17 - Заказ с таким номером уже существует.

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

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

<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
  <auth extra="8" login="login" pass="pass"></auth>
  <client>CLIENT</client>
  <orderno>1234</orderno>
  <ordercode>34234</ordercode>
  <givencode>234534</givencode>
  <datefrom>2014-04-03</datefrom>
  <dateto>2014-04-03</dateto>
  <done>ONLY_NOT_DONE</done>
  <changes>ONLY_LAST</changes>
  <quickstatus>NO</quickstatus>
</statusreq>

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

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

  • auth - Авторизация. Обязательный элемент.
  • orderno - Номер заказа. Не обязательный элемент.
  • orderno2 - Номер заказа из срочных. Не обязательный элемент.
  • datefrom - Дата "с". Обязательный элемент.
  • dateto - Дата "по". Обязательный элемент.
  • quickstatus - Указывает "глубину" передаваемых статусов: "YES" (по-умолчанию) - передаются статусы начиная с информации, поступившей от курьера. Такие статусы являются быстрыми (как правило, проставляются курьером сразу после доставки) но не всегда точными. Значение NO запрещает передачу статуса со слов курьера, и выдает только статусы, введенные оператором, как правило вручную. На это требуется больше времени, однако точность гораздо выше. Не рекомендуется совмещать эти типы передачи статусов (чередовать их) при запросе только изменившихся статусов, т.к. в этом случае система будет считать, что статусы у отправлений меняются.
  • done - Может принимать значения:
ONLY_NOT_DONE - Только не доставленные
ONLY_DONE - Только доставленные
Пусто - все корреспонденции


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

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


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

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

<?xml version="1.0" encoding="UTF-8"?>
<statusreq count="23">
 <order orderno="111111" 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>
     <zipcode>125480</zipcode>
     <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>
     <coords lat="55.680327" lon="37.604456"></coords>
   </receiver>
   <weight>5.1</weight>
   <quantity>2</quantity>
   <paytype>CASH</paytype>
   <service>2</service>
   <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">
      <>..</>  (price details are not yet supported)
      ..
   </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>
   <deliveredto>Иванова, секр.</deliveredto>
   <delivereddate>2016-06-02</delivereddate>
   <deliveredtime>17:22</deliveredtime>   
   <items>
      <item code="34533" extcode="abc123" quantity="1" mass="0.2" retprice="37.5" barcode="2345625213125" article="1" returns="0">Мяч</item>
      <item code="34456" extcode="abc124" quantity="2" mass="2" retprice="100" barcode="4645625213138" article="2" returns="0">Обруч</item>
      <item code="34421" extcode="abc125" quantity="3" mass="0.3" retprice="50" barcode="2345625213126" article="3" returns="0">Погремушка желтая</item>
   </items>
 </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:
    • ordercode - внутренний код заказа в системе, применяется для некоторых внутренних операций.
    • givencode - внутренний код заказа в системе, применяется для некоторых внутренних операций.
    • returns - количество данного товара, от которого отказался получатель. Не нулевое только в случае частичного отказа.
  • атрибут code контейнера item - внутренний код строки заказа в системе, применяется для некоторых внутренних операций.
  • coords в контейнере receiver - координаты получателя.
  • currcoords - текущие координаты заказа. Атрибуты:
    • lat - широта
    • lon - долгота
    • accuracy - точность в метрах
    • RequestDateTime - дата/время последнего обновления координат.
  • deliveryprice - стоимость доставки в валюте расчетов с клиентом.
  • status - статус доставки (список статусов см. ниже). Атрибуты:
    • eventstore - филиал, к которому относится текущий статус
    • eventtime - время изменения статуса (время зависит от местонахождения филиала)
    • createtimegmt - время фактического изменения статуса (UTC+3)
    • message - наименование филиала-получателя, при передаче между филиалами
    • title - русское наименование статуса
  • statushistory - история статусов доставки. Содержит список контейнеров status.
  • customstatecode - код статуса клиента. Используется, если клиент предлагает свои коды статусов доставки/причин недоставки.
  • deliveredto - данные о вручении, либо причина недоставки.
  • delivereddate - дата вручения.
  • deliveredtime - время вручения. В случае недоставки может быть пустым.

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

NEW - Новый
ACCEPTED - Получен складом
INVENTORY - Инвентаризация
DEPARTURING - Планируется отправка
DEPARTURE - Отправлено со склада
DELIVERY - Выдан курьеру на доставку
COURIERDELIVERED - Доставлен (предварительно)
COMPLETE - Доставлен
PARTIALLY - Доставлен частично
COURIERRETURN - Возвращено курьером. Курьер не смог доставить до получателя, и вернул заказ обратно на склад. Это промежуточный статус, после которого менеджер выясняет, нужно ли пытаться заново доставить заказ, или это окончательная недоставка.
CANCELED - Не доставлен (Возврат/Отмена)
RETURNING - Планируется возврат
RETURNED - Возвращен
CONFIRM - Согласована доставка
DATECHANGE - Перенос
NEWPICKUP - Создан забор
UNCONFIRM - Не удалось согласовать доставку
PICKUPREADY - Готов к выдаче

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

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

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


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

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

<?xml version="1.0" encoding="UTF-8" ?>
<statusreq>
  <auth extra="8" login="login" pass="pass"></auth>
  <changes>ONLY_LAST</changes>
  <quickstatus>NO</quickstatus>
</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>
</commitlaststatus>

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

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

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

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

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


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

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

<?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="1234">
    <sender>
      <town code="1">Москва город</town>
      <date></date>
    </sender>
    <receiver>
      <town code="1">Москва город</town>
      <date>2015-04-18</date>
    </receiver>
    <weight>0</weight>
    <quantity>1</quantity>
    <currcoords lat="" lon="" accuracy="" RequestDateTime="" />
    <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>
  </order>
</tracking>

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<townlist>
  <codesearch>
    <zipcode>110000</zipcode>
    <kladrcode>0100000100800</kladrcode>
    <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 все элементы могут как отсутствовать, так и комбинироваться. Поиск не чувствителен к регистру.

  • codesearch - Поиск по кодам. В случае использования - контейнеры conditions и limit игнорируются.
 zipcode - Поиск по индексу. Обратите внимание на то, что один почтовый индекс может распространяться на несколько населенных пунктов. В этом случае система вернет несколько записей.
 kladrcode - Поиск по 13-ти значному коду КЛАДР.
 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>
     <shortname>Сочи</shortname>  (not yet supported)
     <typename>город</typename>  (not yet supported)
  </town>
  <town>
     <code>40331</code>
     <city>
       <code>32</code>
       <name>Брянская область</name>
     </city>
     <name>Сочилов хутор</name>
     <shortname>Сочилов</shortname>
     <typename>хутор</typename>
  </town>
  <town>
     <code>114016</code>
     <city>
       <code>60</code>
       <name>Псковская область</name>
     </city>
     <name>Сочихино деревня</name>
     <shortname>Сочихино</shortname>
     <typename>деревня</typename>
  </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>
    </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 - Все. Это поле может быть недоступным в некоторых установках.
  • 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>
    <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>    (not yet supported)
  <item>
  ...
</itemlist>

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

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

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

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

<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist>
 <auth extra="8" login="login" pass="pass"></auth>
 <town>Нижний Тагил</town>
</pvzlist>
  • town - Город получателя.


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

<?xml version="1.0" encoding="UTF-8" ?>
<pvzlist count="2">
  <pvz>
    <code>126</code>
    <clientcode>3</clientcode>
    <name>Нижний Тагил</name>
    <address>622036, г. Нижний Тагил, ул. Циолковского, д. 17</address>
    <phone>+73435417709, +73435254989</phone>
    <comment>Жилое 5-ти этажное здание, торцом к дороге, второе здание от перекрестка Пархоменко-Циолковского.</comment>
  </pvz>
  <pvz>
    <code>245</code>
    <clientcode>NTG1</clientcode>
    <name>На Красноармейской</name>
    <address>КРАСНОАРМЕЙСКАЯ, д.79</address>
    <phone>+7(3435)379-044</phone>
    <comment>Время работы: пн.-пт. 9-18, сб. 10-14</comment>
  </pvz>
</pvzlist>
  • code - Код ПВЗ в системе. Используется в запросе оформления заказов
  • clientcode - Код ПВЗ используемый компанией-подрядчиком.
  • name - Наименование ПВЗ.
  • address - Адрес ПВЗ.
  • phone - Телефоны ПВЗ.
  • comment - Дополнительная информация.

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

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

<?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" ?>
<calculator>
  <auth extra="8" login="login" pass="pass" />
  <calc townfrom="Москва" townto="3800000300000" mass="3.7" mode="1" />
</calculator>

Параметры:

  • townfrom - Город-отправитель
  • townto - Город-получатель
  • mass - Масса в килограммах
  • mode - Режим доставки - число, указывающее на запись в справочнике [Справочник Видов срочности|видов срочности]

В полях город-отправитель и город-получатель можно указывать название города (не рекомендуется!), либо код города из нашего справочника, либо 13-ти значный код КЛАДР.


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

<?xml version="1.0" encoding="UTF-8"?>
<calculator>
  <calc price="1163">
    <townfrom code="1">Москва город</townfrom>
    <townto code="56603">Иркутск город</townto>
    <mass>3.7</mass>
    <mode>1</mode>
    <zone>2</zone>
    <price>1163</price>
    <maxdeliverydays>3</maxdeliverydays>
  </calc>
</calculator>

Параметры:

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

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

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

<?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>
    <price>637.00</price>
    <rur>13430.00</rur>
    <pricekur>570.00</pricekur>
    <priceag>67.00</priceag>
    <payno>42423</payno>
    <paytype>1</paytype>
  </sma>
</smalist>
  • code - Код акта.
  • number - Номер акта в системе.
  • actdate - Дата акта.
  • datepay - Дата оплаты по акту.
  • price - Стоимость услуг.
  • rur - Сумма заказа.
  • pricekur - Стоимость курьерской доставки.
  • priceag - Агентское вознаграждение.
  • payno - Номер платежного поручения.
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.

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

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

<?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="1">
  <specialsma>
    <code>42494</code>
    <addresscode>14424</addresscode>
    <price>314.00</price>
    <rur>8800.00</rur>
    <pricekur>270.00</pricekur>
    <priceag>44.00</priceag>
    <pricecalc>8486.00</pricecalc>
    <paytype>Наличными при получении</paytype>
    <status>Доставлено</status>
  </specialsma>
  <specialsma>
    <code>42495</code>
    <addresscode>14415</addresscode>
    <price>323.00</price>
    <rur>4630.00</rur>
    <pricekur>300.00</pricekur>
    <priceag>23.00</priceag>
    <pricecalc>4306.00</pricecalc>
    <paytype>Наличными при получении</paytype>
    <status>Доставлено</status>
  </specialsma>
</smadetail>
  • code - Код записи.
  • addresscode - Код заказа.
  • price - Стоимость услуг.
  • rur - Сумма заказа.
  • pricekur - Стоимость курьерской доставки.
  • priceag - Агентское вознаграждение.
  • pricecalc - Сумма для передачи агенту.
  • paytype - Тип оплаты: 1 - безнал, 2 - наличными курьером, 3 - наличными в офисе, 4 - перевод на карту.
  • status - Статус заказа.

Настройка расчета тарифа доставки по городу для расчета через API и модули CMS

Настройка тарифа

Запрос стоимости доставки через API (аналогично расчет стоимости доставки в модулях CMS) выполняется только по настроенным тарифам для междугородней доставки. Соответственно, для расчета внутригородского тарифа, его также необходимо продублировать в настройках междугородних тарифах.

Для этого в "Справочники"-"Межгород"-"Зоны" указывается отдельная зона, для направления "Откуда" – Москва, "Куда" – Москва. Далее в "Справочники"-"Межгород"-"Тарифы по зонам" указываем стоимость доставки для данной зоны.

В случае, если у клиента настроены индивидуальные междугородние зоны и тарифы, то необходимо настроить внутригородской тариф в индивидуальных зонах и тарифах.

Источник — «https://wiki.courierexe.ru/index.php?title=API&oldid=4337»