API :: Orders. Получение/изменение данных о Заказах

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

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

http://mycompany.virtpos.ru/api/orders?apikey=MySecret&format=xml

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

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

• id - код клиента, для которого требуется вернуть данные. Если не указан, то возвращаются данные заказов обо всех клиентах.

• external_id - (опционально) код клиента во внешней системе, работает аналогично параметру id

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

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>1</success>
   <orders>
      <paid>0</paid>
      <customer_id>3</customer_id>
      <shipped>0</shipped>
      <cancelled>0</cancelled>
      <shipping_address>Дом 3, корпус 5</shipping_address>
      <shipping_cost>130.00</shipping_cost>
      <pickup_receipt_id />
      <comment>После шести</comment>
      <guid />
      <created_date>2017-08-24 18:45:08</created_date>
      <amount>976.59</amount>
      <discount>10.20</discount>
      <pickup_from_warehouse_id>2</pickup_from_warehouse_id>
      <pickup_from_warehouse_name>Просвещения проспект</pickup_from_warehouse_name>
      <delivery_type_id>1</delivery_type_id>
      <delivery_type_name>Самовывоз</delivery_type_name>
      <payment_type_id>1</payment_type_id>
      <payment_type_name>Оплата при получении</payment_type_name>
      <items>
         <item_id>789</item_id>
         <item_name>Коньяк "Анри" 3-летний 40,0% 0,5л</item_name>
         <image />
         <quantity>3.450</quantity>
         <unit_base_price>100.10</unit_base_price>
         <discount>10.20</discount>
         <amount>335.15</amount>
      </items>
   </orders>
</root>

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

http://mycompany.virtpos.ru/api/get_payment_types?apikey=MySecret&format=xml

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

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>1</success>
   <payment_types>
      <id>1</id>
      <name>Оплата при получении</name>
   </payment_types>
</root>

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

http://mycompany.virtpos.ru/api/get_delivery_types?apikey=MySecret&format=xml

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

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>1</success>
   <delivery_types>
      <id>1</id>
      <name>Самовывоз</name>
   </delivery_types>
</root>

Пример запроса на добавление заказа:

http://mycompany.virtpos.ru/api/orders/add_order?apikey=MySecret&format=xml&id=1

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

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

• id - код клиента, для которого требуется добавить заказ. Обязательный параметр.

• external_id - (опционально) код клиента во внешней системе, работает аналогично параметру id

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

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

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>1</success>
   <order>
      <delivery_type_id>1</delivery_type_id>
      <payment_type_id>1</payment_type_id>
      <customer_id>3</customer_id>
      <shipping_address>Дом 3, корпус 5</shipping_address>
      <shipping_cost>130.00</shipping_cost>
      <pickup_from_warehouse_id>2</pickup_from_warehouse_id>
      <pickup_receipt_id />
      <comment>После шести</comment>
      <items>
         <item>
            <item_id>787</item_id>
            <quantity>2.000</quantity>
            <unit_base_price>320.72</unit_base_price>
            <discount>0</discount>
            <amount>641.44</amount>
         </item>
         <item>
            <item_id>789</item_id>
            <quantity>3.450</quantity>
            <unit_base_price>100.10</unit_base_price>
            <discount>10.2</discount>
            <amount>335.15</amount>
         </item>
      </items>
   </order>
</root>