InSales API - Заказы — различия между версиями

Материал из Insales Wiki
Перейти к: навигация, поиск
(→‎Получение списка заказов)
(→‎Получение списка заказов)
 
(не показано 37 промежуточных версий 8 участников)
Строка 1: Строка 1:
 
=Получение списка заказов=
 
=Получение списка заказов=
 +
 
Запрос: GET /admin/orders.xml
 
Запрос: GET /admin/orders.xml
 +
 +
Возможные параметры запроса:
 +
 +
* deleted - получить удаленные заказы
 +
 +
* status - статус заказа, значения: open/closed
 +
 +
* fulfillment_status - статус доставки, значения: new, accepted, approved, dispatched, delivered, declined, returned
 +
 +
* financial_status - статус оплаты, значения: paid/pending
 +
 +
* delivery_variant - id способа доставки
 +
 +
* page, per_page - для листания заказов, по умолчанию - 25 заказов на странице. Чтобы получить все нужно в цикле листать страницы пока заказы не закончатся
 +
 +
* updated_since, from_id - параметры для [[Получение только изменившихся данных|получения только изменившихся заказов]] смотрите более '''[[Получение только изменившихся данных|подробное описание]]'''.
  
 
Ответ:
 
Ответ:
Строка 188: Строка 205:
 
</pre>
 
</pre>
  
−
''[http://forum.insales.ru/viewtopic.php?pid=3195#p3195 Примечание:]'' Надо передавать параметры ''per_page'' и ''page'' , чтобы пролистать все страницы с заказами.
+
''[http://forum.insales.ru/viewtopic.php?pid=3195#p3195 Примечание:]'' Надо передавать параметры ''limit'' и ''page'' , чтобы пролистать все страницы с заказами.
  
 
=Получение информации о заказе=
 
=Получение информации о заказе=
Строка 202: Строка 219:
 
     <comment/>
 
     <comment/>
 
     <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
 
     <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
 +
    <delivery-variant-id type="integer">58409</delivery-variant-id>
 
     <delivered-at type="timestamp">2010-08-19 10:26:16 +0400</delivered-at>
 
     <delivered-at type="timestamp">2010-08-19 10:26:16 +0400</delivered-at>
 
     <delivery-description>
 
     <delivery-description>
Строка 212: Строка 230:
 
     <key>c6a090e74498a8e18d78f2f1424ffa5e</key>
 
     <key>c6a090e74498a8e18d78f2f1424ffa5e</key>
 
     <number type="integer">2900</number>
 
     <number type="integer">2900</number>
 +
    <payment-gateway-id type="integer">32541</payment-gateway-id>
 
     <payment-description nil="true"/>
 
     <payment-description nil="true"/>
 
     <payment-title>Наличными</payment-title>
 
     <payment-title>Наличными</payment-title>
Строка 284: Строка 303:
 
     <client>
 
     <client>
 
         <client-group-id type="integer" nil="true"/>
 
         <client-group-id type="integer" nil="true"/>
 +
        <fields-values type="array">
 +
            <fields_value>
 +
                <id>58749</id>
 +
                <type>Текстовое поле</type>
 +
                <name>Дополнительная информация</name>
 +
                <value/>
 +
            </fields_value>
 +
        </fields-values>
 
         <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
 
         <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
 
         <email nil="true"/>
 
         <email nil="true"/>
Строка 299: Строка 326:
  
 
Запрос: PUT /admin/orders/#{id}.xml
 
Запрос: PUT /admin/orders/#{id}.xml
 +
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46443</id>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <id>123</id>
 +
            <quantity>1</quantity>
 +
            <sale-price>100</sale-price>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
    <comment>new order</comment>
 +
</order>
 +
</pre>
 +
 +
== Редактирование позиций в заказе ==
 +
 +
При редактировании заказа вы можете выполнить следующие операции с позициями в заказе:
 +
 +
1. Поменять quantity и sale_price у конкретной позиции. ВНИМАНИЕ!! для этого в блоке order-line-attributes вы должны указать id позиции которую пытаетесь обновить.
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46443</id>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <id>123</id>
 +
            <quantity>1</quantity>
 +
            <sale-price>100</sale-price>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
</order>
 +
</pre>
 +
 +
2. Добавить новую позицию. При этом так же, как и при создании заказа вы можете указывать как variant_id так и product_id.
 +
 +
Если вы не указываете sale-price, то будет подставлена цена из товара, иначе та которую вы передали.
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46443</id>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <variant-id>1234</variant-id>
 +
            <quantity>1</quantity>
 +
            <sale-price>100</sale-price>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
</order>
 +
</pre>
 +
 +
3. Удалить позицию
 +
 
<pre>
 
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 
<order>
 
<order>
−
     <id type="integer">36289</id>
+
     <id type="integer">46443</id>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <id>123456</id>
 +
            <_destroy>true</_destroy>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
</order>
 +
</pre>
 +
 
 +
Вы можете выполнить все 3 действия над позициями в одном запросе.
 +
 
 +
Такой запрос изменит позицию с id=123, удалит позицию с id=123456 и добавит новую позицию с variant_id=1234
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46443</id>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <id>123</id>
 +
            <quantity>1</quantity>
 +
            <sale-price>100</sale-price>
 +
        </order-line-attributes>
 +
        <order-line-attributes>
 +
            <variant-id>1234</variant-id>
 +
            <quantity>1</quantity>
 +
            <sale-price>100</sale-price>
 +
        </order-line-attributes>
 +
        <order-line-attributes>
 +
            <id>123456</id>
 +
            <_destroy>true</_destroy>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 
     <comment>
 
     <comment>
−
         Перезвонить завтра
+
</order>
−
     </comment>
+
</pre>
 +
 
 +
== Редактирование значений дополнительных полей ==
 +
 
 +
1. Значение было уже установлено и в заказе вы можете найти его id
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46789</id>
 +
    <fields-values-attributes type="array">
 +
        <fields-value-attribute>
 +
            <id>971</id>
 +
            <value>123</value>
 +
        </fields-value-attribute>
 +
    </fields-values-attributes>
 +
</order>
 +
</pre>
 +
 
 +
2. Значение еще не было установлено и в заказе нет его id
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46789</id>
 +
    <fields-values-attributes type="array">
 +
         <fields-value-attribute>
 +
            <field-id>431</field-id>
 +
            <value>123</value>
 +
        </fields-value-attribute>
 +
    </fields-values-attributes>
 +
</order>
 +
</pre>
 +
 
 +
3. Нужно удалить значение доп поля
 +
 
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
    <id type="integer">46789</id>
 +
    <fields-values-attributes type="array">
 +
        <fields-value-attribute>
 +
            <id>971</id>
 +
            <_destroy>true</_destroy>
 +
        </fields-value-attribute>
 +
     </fields-values-attributes>
 
</order>
 
</order>
 
</pre>
 
</pre>
Строка 311: Строка 471:
 
<pre>
 
<pre>
 
HTTP/1.1 200 OK
 
HTTP/1.1 200 OK
 +
</pre>
 +
 +
== Список возможных значений fulfillment-status ==
 +
<pre>
 +
new - новый
 +
accepted - в обработке
 +
approved - согласован
 +
dispatched - отгружен
 +
delivered - доставлен
 +
declined - отменен
 +
</pre>
 +
 +
== Список возможных значений financial-status ==
 +
<pre>
 +
pending - не оплчен
 +
paid - оплачен
 
</pre>
 
</pre>
  
Строка 320: Строка 496:
 
<pre>
 
<pre>
 
HTTP/1.1 200 OK
 
HTTP/1.1 200 OK
 +
</pre>
 +
 +
=Получение списка полей для оформления заказа=
 +
 +
Если у поля указано system_name оно является системным, иначе, созданное пользователем.
 +
 +
Запрос: GET /admin/orders/fields.xml
 +
 +
Ответ:
 +
<pre>
 +
HTTP/1.1 200 OK
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<fields>
 +
  <client-fields type="array">
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title></title>
 +
      <office-title>&#1060;&#1072;&#1084;&#1080;&#1083;&#1080;&#1103;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>surname</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">0</position>
 +
      <id type="integer">105202</id>
 +
    </client-field>
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title>&#1048;&#1084;&#1103;</title>
 +
      <office-title>&#1048;&#1084;&#1103;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>name</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">1</position>
 +
      <id type="integer">53194</id>
 +
    </client-field>
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title></title>
 +
      <office-title>&#1054;&#1090;&#1095;&#1077;&#1089;&#1090;&#1074;&#1086;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>middlename</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">2</position>
 +
      <id type="integer">115839</id>
 +
    </client-field>
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title nil="true"></title>
 +
      <office-title>&#1058;&#1077;&#1083;&#1077;&#1092;&#1086;&#1085;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>phone</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">3</position>
 +
      <id type="integer">63831</id>
 +
    </client-field>
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title nil="true"></title>
 +
      <office-title>E-mail</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>email</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">4</position>
 +
      <id type="integer">74468</id>
 +
    </client-field>
 +
    <client-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title nil="true"></title>
 +
      <office-title>&#1055;&#1086;&#1076;&#1090;&#1074;&#1077;&#1088;&#1078;&#1076;&#1077;&#1085;&#1080;&#1077; email</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>email_confirmation</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">5</position>
 +
      <id type="integer">75165</id>
 +
    </client-field>
 +
  </client-fields>
 +
  <shipping-address-fields type="array">
 +
    <shipping-address-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title></title>
 +
      <office-title>&#1054;&#1073;&#1083;&#1072;&#1089;&#1090;&#1100;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>state</system-name>
 +
      <obligatory type="boolean">false</obligatory>
 +
      <position type="integer">2</position>
 +
      <id type="integer">3</id>
 +
    </shipping-address-field>
 +
    <shipping-address-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title></title>
 +
      <office-title>&#1043;&#1086;&#1088;&#1086;&#1076;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>city</system-name>
 +
      <obligatory type="boolean">false</obligatory>
 +
      <position type="integer">3</position>
 +
      <id type="integer">4</id>
 +
    </shipping-address-field>
 +
    <shipping-address-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title nil="true"></title>
 +
      <office-title>&#1040;&#1076;&#1088;&#1077;&#1089;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>address</system-name>
 +
      <obligatory type="boolean">false</obligatory>
 +
      <position type="integer">4</position>
 +
      <id type="integer">5</id>
 +
    </shipping-address-field>
 +
    <shipping-address-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title></title>
 +
      <office-title>&#1055;&#1086;&#1095;&#1090;&#1086;&#1074;&#1099;&#1081; &#1080;&#1085;&#1076;&#1077;&#1082;&#1089;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name>zip</system-name>
 +
      <obligatory type="boolean">true</obligatory>
 +
      <position type="integer">5</position>
 +
      <id type="integer">6</id>
 +
    </shipping-address-field>
 +
    <shipping-address-field>
 +
      <for-buyer type="boolean">true</for-buyer>
 +
      <title>&#1053;&#1086;&#1074;&#1086;&#1077; &#1087;&#1086;&#1083;&#1077;</title>
 +
      <office-title>&#1053;&#1086;&#1074;&#1086;&#1077; &#1087;&#1086;&#1083;&#1077;</office-title>
 +
      <active type="boolean">true</active>
 +
      <system-name nil="true"></system-name>
 +
      <obligatory type="boolean">false</obligatory>
 +
      <position type="integer">13</position>
 +
      <id type="integer">127872</id>
 +
    </shipping-address-field>
 +
  </shipping-address-fields>
 +
</fields>
 +
</pre>
 +
 +
=Получение способов доставки=
 +
 +
Запрос: POST /admin/orders/delivery_variants.xml
 +
<pre>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
  <shipping-address>
 +
    <address>Moscow sdfsdfsdf</address>
 +
  </shipping-address>
 +
  <client>
 +
    <email>test@test.com</email>
 +
    <phone>+7 903 223 33 44</phone>
 +
    <name>vasya</name>
 +
  </client>
 +
  <order-lines-attributes type="array">
 +
      <order-line-attributes>
 +
          <variant-id>523375</variant-id>
 +
          <quantity>1</quantity>
 +
      </order-line-attributes>
 +
  </order-lines-attributes>
 +
</order>
 +
</pre>
 +
Ответ:
 +
<pre>
 +
HTTP/1.1 200 OK
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<delivery-variants type="array">
 +
  <delivery-variant>
 +
    <description nil="true"></description>
 +
    <price type="float">500.0</price>
 +
    <position type="integer">1</position>
 +
    <id type="integer">12398</id>
 +
    <title>&#1069;&#1083;&#1077;&#1082;&#1090;&#1088;&#1086;&#1085;&#1085;&#1086;&#1081; &#1087;&#1086;&#1095;&#1090;&#1086;&#1081;</title>
 +
  </delivery-variant>
 +
  <delivery-variant>
 +
    <description>&#1044;&#1086;&#1089;&#1090;&#1072;&#1074;&#1082;&#1072; &#1087;&#1088;&#1086;&#1080;&#1079;&#1074;&#1086;&#1076;&#1080;&#1090;&#1089;&#1103; &#1085;&#1072; &#1089;&#1083;&#1077;&#1076;&#1091;&#1102;&#1097;&#1080;&#1081; &#1076;&#1077;&#1085;&#1100;.</description>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">2</position>
 +
    <id type="integer">15297</id>
 +
    <title>&#1050;&#1091;&#1088;&#1100;&#1077;&#1088;&#1086;&#1084;</title>
 +
  </delivery-variant>
 +
  <delivery-variant>
 +
    <description>&#1073;&#1086;&#1083;&#1100;&#1096;&#1077; 100 &#1088;&#1091;&#1073;&#1083;&#1077;&#1081; &#1073;&#1077;&#1089;&#1087;&#1083;&#1072;&#1090;&#1085;&#1086;</description>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">4</position>
 +
    <id type="integer">15320</id>
 +
    <title>&#1073;&#1086;&#1083;&#1100;&#1096;&#1077; 100 &#1088;&#1091;&#1073;&#1083;&#1077;&#1081; &#1073;&#1077;&#1089;&#1087;&#1083;&#1072;&#1090;&#1085;&#1086;</title>
 +
  </delivery-variant>
 +
</delivery-variants>
 +
 +
</pre>
 +
 +
=Получение способов оплаты=
 +
 +
Запрос: POST /admin/orders/payment_gateways.xml
 +
<pre>
 +
<order>
 +
    <shipping-address>
 +
      <address>Moscow sdfsdfsdf</address>
 +
    </shipping-address>
 +
    <client>
 +
      <email>test@test.com</email>
 +
      <phone>+7 903 223 33 44</phone>
 +
      <name>vasya</name>
 +
    </client>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <variant-id>523375</variant-id>
 +
            <quantity>1</quantity>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
    <delivery-variant-id type="integer">12398</delivery-variant-id>
 +
</order>
 +
</pre>
 +
Ответ:
 +
<pre>
 +
HTTP/1.1 200 OK
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<payment-gateways type="array">
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">5</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">1797</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1063;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Web Money</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.4</margin-fraction>
 +
    <price type="float">535.2</price>
 +
    <position type="integer">6</position>
 +
    <margin type="decimal">40.0</margin>
 +
    <id type="integer">2958</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1053;&#1072;&#1083;&#1086;&#1078;&#1077;&#1085;&#1085;&#1099;&#1084; &#1087;&#1083;&#1072;&#1090;&#1077;&#1078;&#1086;&#1084;</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">8</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">8190</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1063;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Robox</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">9</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16141</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1042;&#1099;&#1089;&#1090;&#1072;&#1074;&#1083;&#1077;&#1085;&#1080;&#1077; &#1089;&#1095;&#1077;&#1090;&#1072; &#1076;&#1083;&#1103; &#1102;&#1088;. &#1083;&#1080;&#1094;</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">10</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16142</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1055;&#1083;&#1072;&#1089;&#1090;&#1080;&#1082;&#1086;&#1074;&#1086;&#1081; &#1082;&#1072;&#1088;&#1090;&#1086;&#1081; &#1095;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Assist</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">12</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16146</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1055;&#1083;&#1072;&#1090;&#1077;&#1078; &#1095;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; RBKMoney</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">14</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16163</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1063;&#1077;&#1088;&#1077;&#1079; &#1071;&#1085;&#1076;&#1077;&#1082;&#1089;.&#1044;&#1077;&#1085;&#1100;&#1075;&#1080;</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">15</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16164</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1063;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Liqpay</title>
 +
  </payment-gateway>
 +
  <payment-gateway>
 +
    <description></description>
 +
    <margin-fraction type="float">0.0</margin-fraction>
 +
    <price type="float">0.0</price>
 +
    <position type="integer">16</position>
 +
    <margin type="decimal">0.0</margin>
 +
    <id type="integer">16170</id>
 +
    <account-id type="integer">10</account-id>
 +
    <title>&#1042; &#1082;&#1088;&#1077;&#1076;&#1080;&#1090; &#1095;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Robox</title>
 +
  </payment-gateway>
 +
</payment-gateways>
 +
</pre>
 +
 +
=Создание заказа=
 +
 +
Запрос: POST /admin/orders.xml
 +
 +
ВНИМАНИЕ! при передаче флага force=true, происходит валидация только системных полей у объектов Клиент и Адрес доставки,
 +
а так же в случае отсутствия полей payment-gateway-id и delivery-variant-id их подстановка первыми возможными вариантами.
 +
 +
Если в shipping-address не заданы поля country, city, state, то используются значения указанные в настройках магазина
 +
 +
1. Если заданы все поля (включая добавленные владельцем магазина)
 +
<pre>
 +
<order>
 +
    <shipping-address>
 +
      <address>Moscow sdfsdfsdf</address>
 +
    </shipping-address>
 +
    <client>
 +
      <email>test@test.com</email>
 +
      <phone>+7 903 223 33 44</phone>
 +
      <name>vasya</name>
 +
    </client>
 +
    <fields-values-attributes type="array">
 +
      <fields-value-attributes>
 +
        <value>test</value>
 +
        <field-id type="integer">12312</field-id>
 +
      </fields-value-attributes>
 +
    </fields-values-attributes>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <variant-id>523375</variant-id>
 +
            <quantity>1</quantity>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
    <payment-gateway-id type="integer">1797</payment-gateway-id>
 +
    <delivery-variant-id type="integer">12398</delivery-variant-id>
 +
</order>
 +
</pre>
 +
2. Заполнены все системные поля и способы доставки и оплаты
 +
<pre>
 +
<order>
 +
    <force type="boolean">true</force>
 +
    <shipping-address>
 +
      <address>Moscow sdfsdfsdf</address>
 +
    </shipping-address>
 +
    <client>
 +
      <email>test@test.com</email>
 +
      <phone>+7 903 223 33 44</phone>
 +
      <name>vasya</name>
 +
    </client>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <variant-id>523375</variant-id>
 +
            <quantity>1</quantity>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
    <payment-gateway-id type="integer">1797</payment-gateway-id>
 +
    <delivery-variant-id type="integer">12398</delivery-variant-id>
 +
</order>
 +
</pre>
 +
 +
2. Заполнены все системные поля без способов доставки и оплаты (будут использованы первые возможные)
 +
<pre>
 +
<order>
 +
    <force type="boolean">true</force>
 +
    <shipping-address>
 +
      <address>Moscow sdfsdfsdf</address>
 +
    </shipping-address>
 +
    <client>
 +
      <email>test@test.com</email>
 +
      <phone>+7 903 223 33 44</phone>
 +
      <name>vasya</name>
 +
    </client>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <variant-id>523375</variant-id>
 +
            <quantity>1</quantity>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
</order>
 +
</pre>
 +
 +
3. Вместо variant_id можно указывать product_id. В этом случае будет использована первая модификация товара
 +
<pre>
 +
<order>
 +
    <force type="boolean">true</force>
 +
    <shipping-address>
 +
      <address>Moscow sdfsdfsdf</address>
 +
    </shipping-address>
 +
    <client>
 +
      <email>test@test.com</email>
 +
      <phone>+7 903 223 33 44</phone>
 +
      <name>vasya</name>
 +
    </client>
 +
    <order-lines-attributes type="array">
 +
        <order-line-attributes>
 +
            <product-id>523375</product-id>
 +
            <quantity>1</quantity>
 +
        </order-line-attributes>
 +
    </order-lines-attributes>
 +
</order>
 +
</pre>
 +
 +
Ответ:
 +
<pre>
 +
HTTP/1.1 200 OK
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<order>
 +
  <accepted-at type="timestamp" nil="true"></accepted-at>
 +
  <comment nil="true"></comment>
 +
  <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
 +
  <delivered-at type="timestamp" nil="true"></delivered-at>
 +
  <delivery-date type="date" nil="true"></delivery-date>
 +
  <delivery-description>&#1069;&#1083;&#1077;&#1082;&#1090;&#1088;&#1086;&#1085;&#1085;&#1086;&#1081; &#1087;&#1086;&#1095;&#1090;&#1086;&#1081;</delivery-description>
 +
  <delivery-from-hour type="integer" nil="true"></delivery-from-hour>
 +
  <delivery-price type="decimal">500.0</delivery-price>
 +
  <delivery-to-hour type="integer" nil="true"></delivery-to-hour>
 +
  <financial-status>pending</financial-status>
 +
  <fulfillment-status>new</fulfillment-status>
 +
  <id type="integer">46543</id>
 +
  <key>0ee38fb18326fb242f4c6ee559bbdc93</key>
 +
  <number type="integer">1204</number>
 +
  <payment-description nil="true"></payment-description>
 +
  <payment-title>&#1063;&#1077;&#1088;&#1077;&#1079; &#1089;&#1080;&#1089;&#1090;&#1077;&#1084;&#1091; Web Money</payment-title>
 +
  <referer nil="true"></referer>
 +
  <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
 +
  <total-price type="decimal">506.0</total-price>
 +
  <shipping-address>
 +
    <address>Moscow sdfsdfsdf</address>
 +
    <city>&#1052;&#1086;&#1089;&#1082;&#1074;&#1072;</city>
 +
    <country>RU</country>
 +
    <middlename nil="true"></middlename>
 +
    <name>vasya</name>
 +
    <phone>+79032233344</phone>
 +
    <state>&#1052;&#1086;&#1089;&#1082;&#1086;&#1074;&#1089;&#1082;&#1072;&#1103; &#1086;&#1073;&#1083;&#1072;&#1089;&#1090;&#1100;</state>
 +
    <surname nil="true"></surname>
 +
    <zip nil="true"></zip>
 +
    <fields-values type="array"/>
 +
  </shipping-address>
 +
  <order-lines type="array">
 +
    <order-line>
 +
      <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
 +
      <id type="integer">123880</id>
 +
      <product-id type="integer">379982</product-id>
 +
      <quantity type="integer">1</quantity>
 +
      <sale-price type="decimal">6.0</sale-price>
 +
      <sku nil="true"></sku>
 +
      <title>DMW30AJ</title>
 +
      <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
 +
      <variant-id type="integer">517216</variant-id>
 +
      <weight type="decimal" nil="true"></weight>
 +
    </order-line>
 +
  </order-lines>
 +
  <discounts type="array"/>
 +
  <client>
 +
    <client-group-id type="integer" nil="true"></client-group-id>
 +
    <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
 +
    <email>test@test.com</email>
 +
    <id type="integer">46603</id>
 +
    <middlename nil="true"></middlename>
 +
    <name>vasya</name>
 +
    <phone>+7 903 223 33 44</phone>
 +
    <registered type="boolean">false</registered>
 +
    <subscribe type="boolean">true</subscribe>
 +
    <surname nil="true"></surname>
 +
    <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
 +
  </client>
 +
</order>
 
</pre>
 
</pre>

Текущая версия на 08:24, 28 марта 2016

Получение списка заказов

Запрос: GET /admin/orders.xml

Возможные параметры запроса:

  • deleted - получить удаленные заказы
  • status - статус заказа, значения: open/closed
  • fulfillment_status - статус доставки, значения: new, accepted, approved, dispatched, delivered, declined, returned
  • financial_status - статус оплаты, значения: paid/pending
  • delivery_variant - id способа доставки
  • page, per_page - для листания заказов, по умолчанию - 25 заказов на странице. Чтобы получить все нужно в цикле листать страницы пока заказы не закончатся

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<orders type="array">
    <order>
        <accepted-at type="timestamp" nil="true"/>
        <comment/>
        <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
        <delivered-at type="timestamp">2010-08-19 10:26:16 +0400</delivered-at>
        <delivery-description>
            Самовывоз + скидка 2%, тк. до этого делала зказ свыше 2 тысяч
        </delivery-description>
        <delivery-price type="decimal">0.0</delivery-price>
        <financial-status>paid</financial-status>
        <fulfillment-status>delivered</fulfillment-status>
        <id type="integer">36289</id>
        <key>c6a090e74498a8e18d78f2f1424ffa5e</key>
        <number type="integer">2900</number>
        <payment-description nil="true"/>
        <payment-title>Наличными</payment-title>
        <referer/>
        <updated-at type="timestamp">2010-08-19 10:26:16 +0400</updated-at>
        <delivery-date type="date">2011-06-02</delivery-date>
        <delivery-from-hour type="integer">22</delivery-from-hour>
        <delivery-to-hour type="integer">23</delivery-to-hour>
        <shipping-address>
            <address>Самовывоз</address>
            <city>Москва</city>
            <country>RU</country>
            <name>Самовывоз</name>
            <phone>Самовывоз</phone>
            <state>Московская область</state>
            <zip nil="true"/>
        </shipping-address>
        <order-lines type="array">
            <order-line>
                <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
                <id type="integer">94695</id>
                <quantity type="integer">1</quantity>
                <sale-price type="decimal">740.0</sale-price>
                <sku>QP023MVEN-g</sku>
                <title>Van Gogh Sketchbook Emerald</title>
                <updated-at type="timestamp">2010-08-16 18:39:58 +0400</updated-at>
                <variant-id type="integer">16637</variant-id>
                <weight type="decimal">1.5</weight>
            </order-line>
        </order-lines>
        <discounts type="array">
            <discount>
                <created-at type="timestamp">2010-08-19 10:25:51 +0400</created-at>
                <description>2%</description>
                <id type="integer">3347</id>
                <updated-at type="timestamp">2010-08-19 10:25:51 +0400</updated-at>
                <amount type="integer">15</amount>
            </discount>
        </discounts>
        <client>
            <client-group-id type="integer" nil="true"/>
            <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
            <email nil="true"/>
            <id type="integer">36854</id>
            <name>Самовывоз</name>
            <phone>Самовывоз</phone>
            <registered type="boolean">false</registered>
            <subscribe type="boolean">true</subscribe>
            <updated-at type="timestamp">2010-08-16 18:39:58 +0400</updated-at>
        </client>
    </order>
    <order>
        <accepted-at type="timestamp" nil="true"/>
        <comment/>
        <created-at type="timestamp">2010-08-16 14:39:46 +0400</created-at>
        <delivered-at type="timestamp">2010-08-19 10:25:11 +0400</delivered-at>
        <delivery-description>Курьером по Москве (на следующий рабочий день)</delivery-description>
        <delivery-price type="decimal">200.0</delivery-price>
        <financial-status>paid</financial-status>
        <fulfillment-status>delivered</fulfillment-status>
        <id type="integer">36228</id>
        <key>93dc91ffaa5d48025c38d4663f2adb93</key>
        <number type="integer">2899</number>
        <payment-description nil="true"/>
        <payment-title>Наличными</payment-title>
        <referer>
            http://www.google.ru/search?hl=ru&newwindow=1&q=%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%BD%D0%B0%D1%8F+%D0%BA%D0%BD%D0%B8%D0%B6%D0%BA%D0%B0+%D0%BA%D1%83%D0%BF%D0%B8%D1%82%D1%8C&lr=&aq=f&aqi=&aql=&oq=&gs_rfai=
        </referer>
        <updated-at type="timestamp">2010-08-19 10:25:11 +0400</updated-at>
        <delivery-date type="date">2011-06-02</delivery-date>
        <delivery-from-hour type="integer">22</delivery-from-hour>
        <delivery-to-hour type="integer">23</delivery-to-hour>
        <shipping-address>
            <address>ул. Ленина д. 12</address>
            <city>Москва</city>
            <country>RU</country>
            <name>Артем Демидчик</name>
            <phone>8 915 123 45 67</phone>
            <state>Московская область</state>
            <zip nil="true"/>
        </shipping-address>
        <order-lines type="array">
            <order-line>
                <created-at type="timestamp">2010-08-16 16:04:40 +0400</created-at>
                <id type="integer">94612</id>
                <quantity type="integer">1</quantity>
                <sale-price type="decimal">720.0</sale-price>
                <sku>QP617EN</sku>
                <title>Moleskine Soft Large Squared Notebook</title>
                <updated-at type="timestamp">2010-08-16 16:04:40 +0400</updated-at>
                <variant-id type="integer">16325</variant-id>
                <weight type="decimal">1.5</weight>
            </order-line>
        </order-lines>
        <discounts type="array"/>
        <client>
            <client-group-id type="integer" nil="true"/>
            <created-at type="timestamp">2010-08-16 14:39:46 +0400</created-at>
            <email>artem@gmail.com</email>
            <id type="integer">36794</id>
            <name>Артем Демидчик</name>
            <phone>8 915 123 45 67</phone>
            <registered type="boolean">true</registered>
            <subscribe type="boolean">true</subscribe>
            <updated-at type="timestamp">2010-08-16 14:39:46 +0400</updated-at>
        </client>
    </order>
    <order>
        <accepted-at type="timestamp">2010-08-16 14:31:01 +0400</accepted-at>
        <comment/>
        <created-at type="timestamp">2010-08-16 14:14:50 +0400</created-at>
        <delivered-at type="timestamp" nil="true"/>
        <delivery-description>
            Самовывоз (Бронь заказа не более 2 дней, забор  с 10 до 18  часов по рабочим дням, адрес см. на сайте магазина)
        </delivery-description>
        <delivery-price type="decimal">0.0</delivery-price>
        <financial-status>pending</financial-status>
        <fulfillment-status>approved</fulfillment-status>
        <id type="integer">36218</id>
        <key>4ecee989d7e429bf55cead7cdc616adf</key>
        <number type="integer">2898</number>
        <payment-description nil="true"/>
        <payment-title>Наличными</payment-title>
        <referer>
            http://yandex.ru/yandsearch?text=%D0%B1%D0%BB%D0%BE%D0%BA%D0%BD%D0%BE%D1%82%D1%8B+moleskine&lr=213
        </referer>
        <updated-at type="timestamp">2010-08-20 15:25:02 +0400</updated-at>
        <delivery-date type="date" nil="true"/>
        <delivery-from-hour type="integer" nil="true"/>
        <delivery-to-hour type="integer" nil="true"/>
        <shipping-address>
            <address>Рязанский проспект 12</address>
            <city>Москва</city>
            <country>RU</country>
            <name>Слесарев Игорь</name>
            <phone>+7 903 321-54-76</phone>
            <state>Московская область</state>
            <zip nil="true"/>
        </shipping-address>
        <order-lines type="array">
            <order-line>
                <created-at type="timestamp">2010-08-16 14:14:50 +0400</created-at>
                <id type="integer">94519</id>
                <quantity type="integer">1</quantity>
                <sale-price type="decimal">1590.0</sale-price>
                <sku>DHB12DC5QEN</sku>
                <title>Ежедневник "Classic" (2011), A4, черный</title>
                <updated-at type="timestamp">2010-08-16 14:14:50 +0400</updated-at>
                <variant-id type="integer">1199651</variant-id>
                <weight type="decimal">1.5</weight>
            </order-line>
        </order-lines>
        <discounts type="array"/>
        <client>
            <client-group-id type="integer" nil="true"/>
            <created-at type="timestamp">2010-08-16 14:14:50 +0400</created-at>
            <email>igor@yandex.ru</email>
            <id type="integer">36784</id>
            <name>Слесарев Игорь</name>
            <phone>+7 903 321-54-65</phone>
            <registered type="boolean">true</registered>
            <subscribe type="boolean">true</subscribe>
            <updated-at type="timestamp">2010-08-16 14:14:50 +0400</updated-at>
        </client>
    </order>
</orders>

Примечание: Надо передавать параметры limit и page , чтобы пролистать все страницы с заказами.

Получение информации о заказе

Запрос: GET /admin/orders/#{id}.xml

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
    <accepted-at type="timestamp" nil="true"/>
    <comment/>
    <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
    <delivery-variant-id type="integer">58409</delivery-variant-id>
    <delivered-at type="timestamp">2010-08-19 10:26:16 +0400</delivered-at>
    <delivery-description>
        Самовывоз + скидка 2%, тк. до этого делала зказ свыше 2 тысяч
    </delivery-description>
    <delivery-price type="decimal">0.0</delivery-price>
    <financial-status>paid</financial-status>
    <fulfillment-status>delivered</fulfillment-status>
    <id type="integer">36289</id>
    <key>c6a090e74498a8e18d78f2f1424ffa5e</key>
    <number type="integer">2900</number>
    <payment-gateway-id type="integer">32541</payment-gateway-id>
    <payment-description nil="true"/>
    <payment-title>Наличными</payment-title>
    <referer/>
    <updated-at type="timestamp">2010-08-19 10:26:16 +0400</updated-at>
    <delivery-date type="date">2011-06-02</delivery-date>
    <delivery-from-hour type="integer">22</delivery-from-hour>
    <delivery-to-hour type="integer">23</delivery-to-hour>
    <shipping-address>
        <address nil="true"/>
        <city nil="true"/>
        <country>RU</country>
        <name nil="true"/>
        <phone nil="true"/>
        <state nil="true"/>
        <zip nil="true"/>
        <fields-values type="array">
            <fields_value>
                <id>58735</id>
                <type>Выпадающий список</type>
                <name>Время доставки</name>
                <value/>
            </fields_value>
            <fields_value>
                <id>58734</id>
                <type>Российский адрес</type>
                <name>Адрес по КЛАДР-у</name>
                <number/>
                <korp>2</korp>
                <house>8</house>
                <flat>307</flat>
                <manual_index>355000</manual_index>
                <str/>
                <adr1>Ставропольский</adr1>
                <socr1>край</socr1>
                <adr2/>
                <socr2/>
                <adr3>Ставрополь</adr3>
                <socr3>г</socr3>
                <adr4/>
                <socr4/><code>26000001000025900</code>
                <adr5>М.Морозова</adr5>
                <socr5>ул</socr5>
                <address_type>1</address_type>
                 <index/>
                <string>г. Ставрополь, ул. М.Морозова</string>
            </fields_value>
        </fields-values>
    </shipping-address>
    <order-lines type="array">
        <order-line>
            <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
            <id type="integer">94695</id>
            <quantity type="integer">1</quantity>
            <sale-price type="decimal">740.0</sale-price>
            <sku>QP023MVEN-g</sku>
            <title>Van Gogh Sketchbook Emerald</title>
            <updated-at type="timestamp">2010-08-16 18:39:58 +0400</updated-at>
            <variant-id type="integer">16637</variant-id>
            <weight type="decimal">1.5</weight>
        </order-line>
    </order-lines>
    <discounts type="array">
        <discount>
            <created-at type="timestamp">2010-08-19 10:25:51 +0400</created-at>
            <description>2%</description>
            <id type="integer">3347</id>
            <updated-at type="timestamp">2010-08-19 10:25:51 +0400</updated-at>
            <amount type="integer">15</amount>
        </discount>
    </discounts>
    <client>
        <client-group-id type="integer" nil="true"/>
        <fields-values type="array">
            <fields_value>
                <id>58749</id>
                <type>Текстовое поле</type>
                <name>Дополнительная информация</name>
                <value/>
            </fields_value>
        </fields-values>
        <created-at type="timestamp">2010-08-16 18:39:58 +0400</created-at>
        <email nil="true"/>
        <id type="integer">36854</id>
        <name>Самовывоз</name>
        <phone>Самовывоз</phone>
        <registered type="boolean">false</registered>
        <subscribe type="boolean">true</subscribe>
        <updated-at type="timestamp">2010-08-16 18:39:58 +0400</updated-at>
    </client>
</order>

Редактирование заказа

Запрос: PUT /admin/orders/#{id}.xml 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46443</id>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <id>123</id>
            <quantity>1</quantity>
            <sale-price>100</sale-price>
        </order-line-attributes>
    </order-lines-attributes>
    <comment>new order</comment>
</order>

Редактирование позиций в заказе

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

1. Поменять quantity и sale_price у конкретной позиции. ВНИМАНИЕ!! для этого в блоке order-line-attributes вы должны указать id позиции которую пытаетесь обновить. 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46443</id>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <id>123</id>
            <quantity>1</quantity>
            <sale-price>100</sale-price>
        </order-line-attributes>
    </order-lines-attributes>
</order>

2. Добавить новую позицию. При этом так же, как и при создании заказа вы можете указывать как variant_id так и product_id.

Если вы не указываете sale-price, то будет подставлена цена из товара, иначе та которую вы передали. 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46443</id>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <variant-id>1234</variant-id>
            <quantity>1</quantity>
            <sale-price>100</sale-price>
        </order-line-attributes>
    </order-lines-attributes>
</order>

3. Удалить позицию 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46443</id>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <id>123456</id>
            <_destroy>true</_destroy>
        </order-line-attributes>
    </order-lines-attributes>
</order>

Вы можете выполнить все 3 действия над позициями в одном запросе.

Такой запрос изменит позицию с id=123, удалит позицию с id=123456 и добавит новую позицию с variant_id=1234 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46443</id>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <id>123</id>
            <quantity>1</quantity>
            <sale-price>100</sale-price>
        </order-line-attributes>
        <order-line-attributes>
            <variant-id>1234</variant-id>
            <quantity>1</quantity>
            <sale-price>100</sale-price>
        </order-line-attributes>
        <order-line-attributes>
            <id>123456</id>
            <_destroy>true</_destroy>
        </order-line-attributes>
    </order-lines-attributes>
    <comment>
</order>

Редактирование значений дополнительных полей

1. Значение было уже установлено и в заказе вы можете найти его id 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46789</id>
    <fields-values-attributes type="array">
        <fields-value-attribute>
            <id>971</id>
            <value>123</value>
        </fields-value-attribute>
    </fields-values-attributes>
</order>

2. Значение еще не было установлено и в заказе нет его id 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46789</id>
    <fields-values-attributes type="array">
        <fields-value-attribute>
            <field-id>431</field-id>
            <value>123</value>
        </fields-value-attribute>
    </fields-values-attributes>
</order>

3. Нужно удалить значение доп поля 

<?xml version="1.0" encoding="UTF-8"?>
<order>
    <id type="integer">46789</id>
    <fields-values-attributes type="array">
        <fields-value-attribute>
            <id>971</id>
            <_destroy>true</_destroy>
        </fields-value-attribute>
    </fields-values-attributes>
</order>

Ответ: 

HTTP/1.1 200 OK

Список возможных значений fulfillment-status

new - новый
accepted - в обработке
approved - согласован
dispatched - отгружен
delivered - доставлен
declined - отменен

Список возможных значений financial-status

pending - не оплчен
paid - оплачен

Удаление заказа

Запрос: DELETE /admin/orders/#{id}.xml

Ответ: 

HTTP/1.1 200 OK

Получение списка полей для оформления заказа

Если у поля указано system_name оно является системным, иначе, созданное пользователем.

Запрос: GET /admin/orders/fields.xml

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<fields>
  <client-fields type="array">
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title></title>
      <office-title>Фамилия</office-title>
      <active type="boolean">true</active>
      <system-name>surname</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">0</position>
      <id type="integer">105202</id>
    </client-field>
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title>Имя</title>
      <office-title>Имя</office-title>
      <active type="boolean">true</active>
      <system-name>name</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">1</position>
      <id type="integer">53194</id>
    </client-field>
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title></title>
      <office-title>Отчество</office-title>
      <active type="boolean">true</active>
      <system-name>middlename</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">2</position>
      <id type="integer">115839</id>
    </client-field>
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title nil="true"></title>
      <office-title>Телефон</office-title>
      <active type="boolean">true</active>
      <system-name>phone</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">3</position>
      <id type="integer">63831</id>
    </client-field>
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title nil="true"></title>
      <office-title>E-mail</office-title>
      <active type="boolean">true</active>
      <system-name>email</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">4</position>
      <id type="integer">74468</id>
    </client-field>
    <client-field>
      <for-buyer type="boolean">true</for-buyer>
      <title nil="true"></title>
      <office-title>Подтверждение email</office-title>
      <active type="boolean">true</active>
      <system-name>email_confirmation</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">5</position>
      <id type="integer">75165</id>
    </client-field>
  </client-fields>
  <shipping-address-fields type="array">
    <shipping-address-field>
      <for-buyer type="boolean">true</for-buyer>
      <title></title>
      <office-title>Область</office-title>
      <active type="boolean">true</active>
      <system-name>state</system-name>
      <obligatory type="boolean">false</obligatory>
      <position type="integer">2</position>
      <id type="integer">3</id>
    </shipping-address-field>
    <shipping-address-field>
      <for-buyer type="boolean">true</for-buyer>
      <title></title>
      <office-title>Город</office-title>
      <active type="boolean">true</active>
      <system-name>city</system-name>
      <obligatory type="boolean">false</obligatory>
      <position type="integer">3</position>
      <id type="integer">4</id>
    </shipping-address-field>
    <shipping-address-field>
      <for-buyer type="boolean">true</for-buyer>
      <title nil="true"></title>
      <office-title>Адрес</office-title>
      <active type="boolean">true</active>
      <system-name>address</system-name>
      <obligatory type="boolean">false</obligatory>
      <position type="integer">4</position>
      <id type="integer">5</id>
    </shipping-address-field>
    <shipping-address-field>
      <for-buyer type="boolean">true</for-buyer>
      <title></title>
      <office-title>Почтовый индекс</office-title>
      <active type="boolean">true</active>
      <system-name>zip</system-name>
      <obligatory type="boolean">true</obligatory>
      <position type="integer">5</position>
      <id type="integer">6</id>
    </shipping-address-field>
    <shipping-address-field>
      <for-buyer type="boolean">true</for-buyer>
      <title>Новое поле</title>
      <office-title>Новое поле</office-title>
      <active type="boolean">true</active>
      <system-name nil="true"></system-name>
      <obligatory type="boolean">false</obligatory>
      <position type="integer">13</position>
      <id type="integer">127872</id>
    </shipping-address-field>
  </shipping-address-fields>
</fields>

Получение способов доставки

Запрос: POST /admin/orders/delivery_variants.xml 

<?xml version="1.0" encoding="UTF-8"?>
<order>
  <shipping-address>
    <address>Moscow sdfsdfsdf</address>
  </shipping-address>
  <client>
    <email>test@test.com</email>
    <phone>+7 903 223 33 44</phone>
    <name>vasya</name>
  </client>
  <order-lines-attributes type="array">
      <order-line-attributes>
          <variant-id>523375</variant-id>
          <quantity>1</quantity>
      </order-line-attributes>
  </order-lines-attributes>
</order>

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<delivery-variants type="array">
  <delivery-variant>
    <description nil="true"></description>
    <price type="float">500.0</price>
    <position type="integer">1</position>
    <id type="integer">12398</id>
    <title>Электронной почтой</title>
  </delivery-variant>
  <delivery-variant>
    <description>Доставка производится на следующий день.</description>
    <price type="float">0.0</price>
    <position type="integer">2</position>
    <id type="integer">15297</id>
    <title>Курьером</title>
  </delivery-variant>
  <delivery-variant>
    <description>больше 100 рублей бесплатно</description>
    <price type="float">0.0</price>
    <position type="integer">4</position>
    <id type="integer">15320</id>
    <title>больше 100 рублей бесплатно</title>
  </delivery-variant>
</delivery-variants>

Получение способов оплаты

Запрос: POST /admin/orders/payment_gateways.xml 

<order>
    <shipping-address>
      <address>Moscow sdfsdfsdf</address>
    </shipping-address>
    <client>
      <email>test@test.com</email>
      <phone>+7 903 223 33 44</phone>
      <name>vasya</name>
    </client>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <variant-id>523375</variant-id>
            <quantity>1</quantity>
        </order-line-attributes>
    </order-lines-attributes>
    <delivery-variant-id type="integer">12398</delivery-variant-id>
</order>

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<payment-gateways type="array">
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">5</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">1797</id>
    <account-id type="integer">10</account-id>
    <title>Через систему Web Money</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.4</margin-fraction>
    <price type="float">535.2</price>
    <position type="integer">6</position>
    <margin type="decimal">40.0</margin>
    <id type="integer">2958</id>
    <account-id type="integer">10</account-id>
    <title>Наложенным платежом</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">8</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">8190</id>
    <account-id type="integer">10</account-id>
    <title>Через систему Robox</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">9</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16141</id>
    <account-id type="integer">10</account-id>
    <title>Выставление счета для юр. лиц</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">10</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16142</id>
    <account-id type="integer">10</account-id>
    <title>Пластиковой картой через систему Assist</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">12</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16146</id>
    <account-id type="integer">10</account-id>
    <title>Платеж через систему RBKMoney</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">14</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16163</id>
    <account-id type="integer">10</account-id>
    <title>Через Яндекс.Деньги</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">15</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16164</id>
    <account-id type="integer">10</account-id>
    <title>Через систему Liqpay</title>
  </payment-gateway>
  <payment-gateway>
    <description></description>
    <margin-fraction type="float">0.0</margin-fraction>
    <price type="float">0.0</price>
    <position type="integer">16</position>
    <margin type="decimal">0.0</margin>
    <id type="integer">16170</id>
    <account-id type="integer">10</account-id>
    <title>В кредит через систему Robox</title>
  </payment-gateway>
</payment-gateways>

Создание заказа

Запрос: POST /admin/orders.xml

ВНИМАНИЕ! при передаче флага force=true, происходит валидация только системных полей у объектов Клиент и Адрес доставки, а так же в случае отсутствия полей payment-gateway-id и delivery-variant-id их подстановка первыми возможными вариантами.

Если в shipping-address не заданы поля country, city, state, то используются значения указанные в настройках магазина

1. Если заданы все поля (включая добавленные владельцем магазина) 

<order>
    <shipping-address>
      <address>Moscow sdfsdfsdf</address>
    </shipping-address>
    <client>
      <email>test@test.com</email>
      <phone>+7 903 223 33 44</phone>
      <name>vasya</name>
    </client>
    <fields-values-attributes type="array">
      <fields-value-attributes>
        <value>test</value>
        <field-id type="integer">12312</field-id>
      </fields-value-attributes>
    </fields-values-attributes>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <variant-id>523375</variant-id>
            <quantity>1</quantity>
        </order-line-attributes>
    </order-lines-attributes>
    <payment-gateway-id type="integer">1797</payment-gateway-id>
    <delivery-variant-id type="integer">12398</delivery-variant-id>
</order>

2. Заполнены все системные поля и способы доставки и оплаты 

<order>
    <force type="boolean">true</force>
    <shipping-address>
      <address>Moscow sdfsdfsdf</address>
    </shipping-address>
    <client>
      <email>test@test.com</email>
      <phone>+7 903 223 33 44</phone>
      <name>vasya</name>
    </client>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <variant-id>523375</variant-id>
            <quantity>1</quantity>
        </order-line-attributes>
    </order-lines-attributes>
    <payment-gateway-id type="integer">1797</payment-gateway-id>
    <delivery-variant-id type="integer">12398</delivery-variant-id>
</order>

2. Заполнены все системные поля без способов доставки и оплаты (будут использованы первые возможные) 

<order>
    <force type="boolean">true</force>
    <shipping-address>
      <address>Moscow sdfsdfsdf</address>
    </shipping-address>
    <client>
      <email>test@test.com</email>
      <phone>+7 903 223 33 44</phone>
      <name>vasya</name>
    </client>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <variant-id>523375</variant-id>
            <quantity>1</quantity>
        </order-line-attributes>
    </order-lines-attributes>
</order>

3. Вместо variant_id можно указывать product_id. В этом случае будет использована первая модификация товара 

<order>
    <force type="boolean">true</force>
    <shipping-address>
      <address>Moscow sdfsdfsdf</address>
    </shipping-address>
    <client>
      <email>test@test.com</email>
      <phone>+7 903 223 33 44</phone>
      <name>vasya</name>
    </client>
    <order-lines-attributes type="array">
        <order-line-attributes>
            <product-id>523375</product-id>
            <quantity>1</quantity>
        </order-line-attributes>
    </order-lines-attributes>
</order>

Ответ: 

HTTP/1.1 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<order>
  <accepted-at type="timestamp" nil="true"></accepted-at>
  <comment nil="true"></comment>
  <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
  <delivered-at type="timestamp" nil="true"></delivered-at>
  <delivery-date type="date" nil="true"></delivery-date>
  <delivery-description>Электронной почтой</delivery-description>
  <delivery-from-hour type="integer" nil="true"></delivery-from-hour>
  <delivery-price type="decimal">500.0</delivery-price>
  <delivery-to-hour type="integer" nil="true"></delivery-to-hour>
  <financial-status>pending</financial-status>
  <fulfillment-status>new</fulfillment-status>
  <id type="integer">46543</id>
  <key>0ee38fb18326fb242f4c6ee559bbdc93</key>
  <number type="integer">1204</number>
  <payment-description nil="true"></payment-description>
  <payment-title>Через систему Web Money</payment-title>
  <referer nil="true"></referer>
  <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
  <total-price type="decimal">506.0</total-price>
  <shipping-address>
    <address>Moscow sdfsdfsdf</address>
    <city>Москва</city>
    <country>RU</country>
    <middlename nil="true"></middlename>
    <name>vasya</name>
    <phone>+79032233344</phone>
    <state>Московская область</state>
    <surname nil="true"></surname>
    <zip nil="true"></zip>
    <fields-values type="array"/>
  </shipping-address>
  <order-lines type="array">
    <order-line>
      <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
      <id type="integer">123880</id>
      <product-id type="integer">379982</product-id>
      <quantity type="integer">1</quantity>
      <sale-price type="decimal">6.0</sale-price>
      <sku nil="true"></sku>
      <title>DMW30AJ</title>
      <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
      <variant-id type="integer">517216</variant-id>
      <weight type="decimal" nil="true"></weight>
    </order-line>
  </order-lines>
  <discounts type="array"/>
  <client>
    <client-group-id type="integer" nil="true"></client-group-id>
    <created-at type="timestamp">2011-12-23 11:31:40 +0400</created-at>
    <email>test@test.com</email>
    <id type="integer">46603</id>
    <middlename nil="true"></middlename>
    <name>vasya</name>
    <phone>+7 903 223 33 44</phone>
    <registered type="boolean">false</registered>
    <subscribe type="boolean">true</subscribe>
    <surname nil="true"></surname>
    <updated-at type="timestamp">2011-12-23 11:31:40 +0400</updated-at>
  </client>
</order>
Источник — «https://wiki.insales.ru/index.php?title=InSales_API_-_Заказы&oldid=6970»