Экспорт документов

Экспорт подразумевает загрузка документов из Сервера “Меркурий” в Учетную систему.

Экспорт осуществляется в формате XML.

Формат запроса

Пример: http://api.mobexpert.ru/acc_get_docs/

Для экспорта документов необходимо сформировать и отправить запрос на сервер меркурий.

Запрос представляет структуру xml файла.

Корневой элемент <root>

Тег “Item” содержит информацию о виде необходимых документов для выгрузки.

Используются следующие атрибуты тега “Item”:

  • type - вид документа для экспорта. Используемые значения: “order” - заявки / “ret” - возвраты
  • onlynew - экспорт новых документов (ранее незагруженных в учетную систему). Используемые значения: 1
  • startdate/enddate - интервал дат времени создания документов для загрузки. Формат даты указывается в формате “ГГГГ-ММ-ДД ЧЧ:ММ:СС” (необязательный)
  • limit - Количество документов к экспорту. (необязательный)

Примеры:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <Item type="order" onlynew="1"/>
</root>

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <Item type="order" startdate="2013-05-01 00:00:00" enddate="2013-05-01 23:59:59"/>
</root>

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <Item type="order" onlynew="1" agent="bd72d8fc-55bc-11d9-848a-00112f43529a"/>
</root>

Формат ответа

Экспорт осуществляется в формате XML.

Корневой элемент <root>.

Каждый документ, как объект загрузки в Учетную систему, имеет тег “doc”

Используются следующие атрибуты тега “doc”:

  • ID - уникальный идентификатор документа на сервере “Меркурий”
  • type - вид документа. Используемые значения: “order”.

Реквизиты документа содержатся в теге <properties>, подчиненному тегу <doc>.

Каждый реквизит документа иммет собственный тег с определенным значением тега.

Используемые теги:

  • <CUSTOMER_ID> - уникальный идентификатор покупателя в учетной системе.
  • <CUSTOMER_NAME> - наименование покупателя.
  • <CONTRACT_ID> - уникальный идентификатор договора покупателя в учетной системе.
  • <CONTRACT_NAME> - наименование договора.
  • <PRICELIST_ID> - уникальный идентификатор типа цен в учетной системе.
  • <PRICELIST_NAME> - наименование типа цен.
  • <SHOP_ID> - уникальный идентификатор торговой точки покупателя в учетной системе.
  • <SHOP_NAME> - наименование торговой точки покупателя.
  • <SHOP_ADDRESS> - адрес торговой торговой точки покупателя.
  • <Agent_ID> - уникальный идентификатор агента (физ. лица) в учетной системе.
  • <ISBONUS> - признак бонуса.
  • <COMMENT> - комментарий к документу.
  • <TOTAL> - общая сумма по документу.
  • <DELIVERY_DATE> - указанная дата доставки.
  • <LASTEDIT_TIME> - время последнего редактирования документа.
  • <VIZIT_ID> - идентификатор визита в рамках которого был оформлен заказ.

Строки табличных частей содержатся в теге <Items>, подчиненному тегу <doc>.

Тег <Items> имеет следующие атрибуты:

  • id - тип табличной части документа. Допустимые значения: 1 - табличная часть товары.

Значения каждой строки содержится в атрибутах тега <Item>, который является дочерним тегу <Items>.

Используются следующие атрибуты тега <Item>:

  • object_id - уникальный идентификатор товара/услуги/тары в учетной системе.
  • object_name - наименование товара/услиги/тары.
  • object_property - дополнительное свойство товара/услиги/тары.
  • amount - количество товара/услуги/тары.
  • price - цена товара/услуги/тары.
  • unit_id - уникальный идентификатор единицы измерения в учетной системе.
  • unit_k - коэффициент перерасчета единицы измерения.
  • weight - общий вес по строке.

Пример:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <doc ID="204f4de8-3fad-45b6-a4ba-f9d4fab0b828" type="order">
    <properties>
          <Agent_ID>14ed8bae-55bd-11d9-848a-00112f43529a</Agent_ID>
          <COMMENT />
          <CONTRACT_NAME>Основной договор</CONTRACT_NAME>
          <ISBONUS>false</ISBONUS>
          <CUSTOMER_ID>53390e27-401f-11dc-abc6-0015e9b8c48d</CUSTOMER_ID>
          <CONTRACT_ID>53390e28-401f-11dc-abc6-0015e9b8c48d</CONTRACT_ID>
          <SHOP_ADDRESS>Москва г, Севастопольский проезд 34</SHOP_ADDRESS>
          <SHOP_NAME>ИП "Гришичкин"</SHOP_NAME>
          <SHOP_ID>53390e27-401f-11dc-abc6-0015e9b8c48d</SHOP_ID>
      <VIZIT_ID>76261e1a-d835-400f-924c-61253cb693b2</VIZIT_ID>
          <LASTEDIT_TIME>2013-04-16 15:05:27</LASTEDIT_TIME>
          <PRICELIST_ID>53390e28-481f-11dc-abc6-0815e9b8c48d</PRICELIST_ID>
          <TOTAL>0</TOTAL>
          <PRICELIST_NAME>Розничная</PRICELIST_NAME>
          <DELIVERY_DATE>2013-04-16 15:05:27</DELIVERY_DATE>
          <CUSTOMER_NAME>ИП "Гришичкин"</CUSTOMER_NAME>
        </properties>
        <Items id="1">
          <Item amount="5.0" object_id="e8a71fab-55bc-11d9-848a-00112f43529a" object_name="Мужские сапоги с натуральным мехом" object_property="" price="2100.33" unit_id="e8a71fac-55bc-11d9-848a-00112f43529a" unit_k="1.0" weight="0.0" />
          <Item amount="2.0" object_id="bd72d92c-55bc-11d9-848a-00112f43529a" object_name="Кофеварка BRAUN KF22R" object_property="" price="19932.0" unit_id="bd72d92d-55bc-11d9-848a-00112f43529a" unit_k="1.0" weight="0.0" />
          <Item amount="36.0" object_id="cbcf4934-55bc-11d9-848a-00112f43529a" object_name="СТИНОЛ 101" object_property="" price="21185.0" unit_id="cbcf4935-55bc-11d9-848a-00112f43529a"      unit_k="1.0" weight="0.0" />
    </Items>
  </doc>
  <doc ID="a9b6f3d2-6d4c-466c-95bb-98dc4db10caf" type="order">
    <properties>
          <Agent_ID>14ed8bae-55bd-11d9-848a-00112f43529a</Agent_ID>
          <COMMENT />
          <CONTRACT_NAME>Основной договор</CONTRACT_NAME>
          <ISBONUS>false</ISBONUS>
          <CUSTOMER_ID>53390e27-401f-11dc-abc6-0015e9b8c48d</CUSTOMER_ID>
          <CONTRACT_ID>53390e28-401f-11dc-abc6-0015e9b8c48d</CONTRACT_ID>
          <SHOP_ADDRESS>Москва г, Севастопольский проезд 34</SHOP_ADDRESS>
          <SHOP_NAME>ИП "Гришичкин"</SHOP_NAME>
          <SHOP_ID>53390e27-401f-11dc-abc6-0015e9b8c48d</SHOP_ID>
          <VIZIT_ID>5acb118c-dcd2-47e9-a1a0-e6dfcc8957af</VIZIT_ID>
          <LASTEDIT_TIME>2013-04-16 14:56:44</LASTEDIT_TIME>
          <PRICELIST_ID>53390e28-481f-11dc-abc6-0815e9b8c48d</PRICELIST_ID>
          <TOTAL>0</TOTAL>
          <PRICELIST_NAME>Розничная</PRICELIST_NAME>
          <DELIVERY_DATE>2013-04-16 14:56:43</DELIVERY_DATE>
          <CUSTOMER_NAME>ИП "Гришичкин"</CUSTOMER_NAME>
    </properties>
    <Items id="1">
          <Item amount="2.0" object_id="e8a71fab-55bc-11d9-848a-00112f43529a" object_name="Мужские сапоги с натуральным мехом" object_property="" price="2100.33" unit_id="e8a71fac-55bc-11d9-848a-00112f43529a" unit_k="1.0" weight="0.0" />
          <Item amount="2.0" object_id="bd72d92c-55bc-11d9-848a-00112f43529a" object_name="КофеваркаBRAUN KF22R" object_property="" price="19932.0" unit_id="bd72d92d-55bc-11d9-848a-00112f43529a"     unit_k="1.0" weight="0.0" />
    </Items>
  </doc>
</root>

Извещение об ошибках

При возникновении ошибок во время подготовки ответа по заросу или некорретности файла запроса.

Файл ответа будет иметь следующий формат.

Значения тега <ERROR> содержит информацию об ошибке.

Пример:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <ERROR>"unknown license"</ERROR>
</root>

Подтверждение загрузки документов

После удачного экспорта документов в учетную систему необходимо отправить запрос на сервер “Меркурий” о подтверждении загрузки документов.

Пример: http://api.mobexpert.ru/acc_accept_docs/

Тег <doc> содержит значение идентификатора документа на сервере “Меркурий”.

Теги содержит следующие атрибуты:

  • id - уникальный идентификатор документа в учетной системе.
  • info - информация о документе (номер, наименование).

Пример:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <doc id="cf5e055e-0585-11e3-9716-000c296d2c77" info="Заказ покупателя ТД0030 от 15.08.2013 12:36:42">83a12660-bf24-4f9a-ae72-ff4e79396f91</doc>
</root>

Подтвеждение от сервера “Меркурий” о изменении статуса документа как загруженного в учетную систему имеет следующий формат.

Значение тега <doc> - результат изменения статуса документа на сервере “Меркурий”.

Атрубут “ID” - идентификатор документа.

Пример:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <doc ID="53cdb5cf-a69b-4d68-a062-a9171036e15c">OK</doc>
  <doc ID="54cdb5cf-a69b-4d68-a062-a9171036e15c">ERROR</doc>
</root>