API :: Receipt. Получение данных о продажах

В системе реализован программный интерфейс для получения данных о продажах. Данные выгружаются по http протоколу. Формат на выбор - xml или json. Данные выгружаются в виде чеков продаж.

Пример запроса на получение данных о продажах (чеков продаж):

http://mycompany.virtpos.ru/api/receipt?apikey=MySecret&marker=394804029:000000010&format=xml

• apikey - Секретный ключ для доступа к данным. Обязательный параметр.

• marker - уникальный идентификатор чека, который был обработан при последнем обмене данными. Параметр нужен для того, чтобы получать только новые чеки, которые еще не были получены ранее. Необязательный параметр. Если параметр указан, то будут отданы все чеки, которые были сформированы после него. Если параметр пустой, то будут отданы все чеки за последние 25 дней

• datefrom - Необязательный параметр. Если указан, то будут отданы данные, поступившие в облако после указанной даты. Формат даты: ГГГГММДД. Необходимо обратить внимание, что дата продажи и дата поступления в облако могут различаться.

• format - формат, в котором сервер отдаст данные. Может принимать значения «xml» или «json». Необязательный параметр.

• fields - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом «:». Необязательный параметр. Поддерживаются следующие поля:
  • itemname - название товара
  • itemid2 - уникальный идентификатор товара во внешней системе (например, в 1С). Значение заполняется при выгрузке товара в ВиртуалПос из внешней системы.
  • warehouseid2 - уникальный идентификатор магазина во внешней системе (например, в 1С). Значение заполняется при выгрузке товара в ВиртуалПос из внешней системы.
  • article - артикул товара
  • user_login - логин продавца
  • user_fio - ФИО продавца
  • discount_name - название скидки, примененной к строке чека
  • customer_id - ID покупателя
  • customer_fname - Имя покупателя
  • customer_lname - Фамилия покупателя
  • customer_mname - Отчество покупателя

В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info

Ниже приведен пример ответа сервера в формате XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>1</success>
   <type>receipt</type>
   <count>2</count>
   <receipts>
      <receipt>
         <receipt_id>1E1208CD-84D2-47ED-B58B-16706FD400B0</receipt_id>
         <marker>1415193742:0000036451</marker>
         <terminalid>00000001</terminalid>
         <warehouseid>1</warehouseid>
         <user_id>19</user_id>
         <fr_session>1</fr_session>
         <doc_type>sale</doc_type>
         <doc_num>10</doc_num>
         <doc_num_session>6</doc_num_session>
         <date>03.11.2014 18:31:49</date>
         <discount>0.00</discount>
         <amount>1749.00</amount>
         <pay_cash>0.00</pay_cash>
         <pay_card>1749.00</pay_card>
         <pay_tare>0.00</pay_tare>
         <pay_credit>0.00</pay_credit>
         <items_count>1</items_count>
         <items>
            <item>
               <line_id>88E41E39-3D0E-5696-78A9-F79A12854B69</line_id>
               <itemid>3580</itemid>
               <quantity>1</quantity>
               <pricebase>1749.00</pricebase>
               <pricesale>1749.00</pricesale>
               <discount>0.00</discount>
               <amount>1749.00</amount>
               <barcode />
               <user_id />
            </item>
         </items>
      </receipt>
      <receipt>
         <receipt_id>2348F9DA-0B8C-45B7-80AE-7B136E6B9F94</receipt_id>
         <marker>1415193742:0000036452</marker>
         <terminalid>00000001</terminalid>
         <warehouseid>1</warehouseid>
         <user_id>19</user_id>
         <fr_session>1</fr_session>
         <doc_type>return</doc_type>
         <doc_num>11</doc_num>
         <doc_num_session>7</doc_num_session>
         <date>04.11.2014 17:02:53</date>
         <discount>0.00</discount>
         <amount>199.00</amount>
         <pay_cash>199.00</pay_cash>
         <pay_card>0.00</pay_card>
         <pay_tare>0.00</pay_tare>
         <pay_credit>0.00</pay_credit>
         <items_count>1</items_count>
         <items>
            <item>
               <line_id>D361F6C1-048D-45FA-CB9C-4633FC25DECA</line_id>
               <itemid>3380</itemid>
               <quantity>1</quantity>
               <pricebase>199.00</pricebase>
               <pricesale>199.00</pricesale>
               <discount>0.00</discount>
               <amount>199.00</amount>
               <barcode />
               <user_id />
            </item>
         </items>
         <sale_receipt_id>D36B3C45-9939-AB11-D9FB-3BA4CB44607E</sale_receipt_id>
         <sale_receipt_date>09.12.2015 17:35:11</sale_receipt_date>
      </receipt>
   </receipts>
</root>