Различия

Здесь показаны различия между двумя версиями данной страницы.

--- doc:dev:api:item [01.09.2017 13:30]
mzubkov [Параметры запроса]
+++ doc:dev:api:item [22.10.2025 12:06] (текущий)
rlysov [Пример запроса на массовое добавление/изменение данных]
@@ Строка 8: / Строка 8: @@
 Пример запроса на получение данных о номенклатуре:
- http://mycompany.virtpos.ru/api/item?apikey=MySecret&format=xml
+ https://[company].myvirtualpos.ru/api/item?apikey=MySecret&format=xml
 ==== Параметры запроса ====
@@ Строка 22: / Строка 22: @@
   * **enabled_only** (get only) - опционально, 1 если нужно получить только активные товары, 0 если все.
+  * **pricelist** - (опционально). В параметре можно передать Id прайслиста. Если ID прайслиста переден, то к каждому товару будут добавлены колонки с ценами из этого прайлиста. Чтобы вернуть цены из прайслиста для интернет-витрины, то вместо ID можно указать ключевое слово "internet": &pricelist=internet.
+  * **images** - опционально. Если указано значение "1", то к каждому товару будет добавлен список файлов с изображениями. Имена файлов будут перечислены через запятую
+  * **from_id** - опционально. Вернуть товары начиная с этого ID
+  * **limit** - опционально. Максимальное количество товаров в ответе
 ==== Ответ сервера ====
@@ Строка 53: / Строка 59: @@
 			<weight_good_flag>N</weight_good_flag>
 			<not_show_in_shop>1</not_show_in_shop>
+                        <html_template_id>5</html_template_id>
 			<external_id/>
 			<group_ids>1,2</group_ids>
@@ Строка 71: / Строка 78: @@
 			<weight_good_flag>N</weight_good_flag>
 			<not_show_in_shop>0</not_show_in_shop>
+                        <html_template_id>5</html_template_id>
 			<external_id>22222</external_id>
 			<group_ids>1,2</group_ids>
@@ Строка 89: / Строка 97: @@
 Пример запроса на добавление/изменение данных о товаре:
- http://mycompany.virtpos.ru/api/item/update?apikey=MySecret&create_if_not_exist=0&external_id=666
+ https://[company].myvirtualpos.ru/api/item/update?apikey=MySecret&create_if_not_exist=0&external_id=666
 ==== Параметры запроса ====
@@ Строка 122: / Строка 130: @@
   * **not_show_in_shop** - показывать или нет товар в интернет-витрине и мобильном приложении. Значения: "0" / "1"
+  * **html_template_id** - id шаблона ценника
   * **category_id** - id товарной категории ("1" - алкоголь / "2" - товары18+ )
@@ Строка 163: / Строка 173: @@
 <file http>
 POST /api/item/updateAll?apikey=11112222&format=xml HTTP/1.1
-HOST: mycompany.virtpos.ru
+HOST: company.myvirtualpos.ru
 content-type: application/x-www-form-urlencoded
 content-length: 89
@@ Строка 173: / Строка 183: @@
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **create_if_not_exist** - Если истина, то при неудачном поиске товар будет добавлен в систему.
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске товар будет добавлен в систему.
 ==== Параметры data ====