Различия

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

--- doc:dev:api:item [19.12.2016 14:53]
asonkin [Параметры запроса]
+++ 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
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код товара, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех товарах.
+  * **id** (get only) - код товара, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех товарах.
-  * **external_id** - код товара во внешней системе учета (например, в 1С)
+  * **external_id** (get only) - код товара во внешней системе учета (например, в 1С)
-  * **enabled_only** - опционально, 1 если нужно получить только активные товары, 0 если все.
+  * **enabled_only** (get only) - опционально, 1 если нужно получить только активные товары, 0 если все.
+  * **pricelist** - (опционально). В параметре можно передать Id прайслиста. Если ID прайслиста переден, то к каждому товару будут добавлены колонки с ценами из этого прайлиста. Чтобы вернуть цены из прайслиста для интернет-витрины, то вместо ID можно указать ключевое слово "internet": &pricelist=internet.
+  * **images** - опционально. Если указано значение "1", то к каждому товару будет добавлен список файлов с изображениями. Имена файлов будут перечислены через запятую
+  * **from_id** - опционально. Вернуть товары начиная с этого ID
+  * **limit** - опционально. Максимальное количество товаров в ответе
 ==== Ответ сервера ====
@@ Строка 38: / Строка 44: @@
 	<success>1</success>
 	<type>item</type>
+	<flexfields>
+		<attribute1>Цвет</attribute1>
+	</flexfields>
 	<count>2</count>
 	<items>
@@ Строка 46: / Строка 55: @@
 			<enabled>1</enabled>
 			<sales_weight>0</sales_weight>
-			<manufacturer_id/>
+			<manufacturer_id>1</manufacturer_id>
+			<type>G</type>
 			<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>
 			<group_ext_ids>{123-543},{000-999}</group_ext_ids>
 			<barcodes>4607092441788,9785864153055</barcodes>
+			<vat_percent>18</vat_percent>
 			<created_date>2015-07-11 17:16:49</created_date>
 			<last_update_date>2015-07-11 17:29:25</last_update_date>
@@ Строка 62: / Строка 74: @@
 			<enabled>1</enabled>
 			<sales_weight>0</sales_weight>
-			<manufacturer_id/>
+			<manufacturer_id>1</manufacturer_id>
+			<type>G</type>
 			<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>
 			<group_ext_ids>{123-543},{000-999}</group_ext_ids>
 			<barcodes>4607092441788,9785864153055</barcodes>
+			<vat_percent>18</vat_percent>
 			<created_date>2015-07-11 17:34:58</created_date>
 			<last_update_date>2015-07-11 17:36:36</last_update_date>
+			<attribute1>Красный</attribute1>
 		</item>
 	</items>
@@ Строка 81: / Строка 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
 ==== Параметры запроса ====
+параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры.
   * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр.
-  * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
+  * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр.
-  * **id** - код товара, данные которого надо обновить
+  * **id** (get only) - код товара, данные которого надо обновить
-  * **external_id** - код товара во внешней системе учета (например, в 1С), данные которого надо обновить
+  * **external_id** (get only) - код товара во внешней системе учета (например, в 1С), данные которого надо обновить
-  * **create_if_not_exist** - Если истина, то при неудачном поиске товар будет добавлен в систему.
+  * **create_if_not_exist** (get only) - Если истина, то при неудачном поиске товар будет добавлен в систему.
   * **manufacturer_name** - Название производителя. Если значение указано, то происходит проверка, есть ли производитель с таким именем в справочнике. Если нет, то он будет добавлен. Параметр игнорируется, если указан manufacturer_id
-  * Также в качестве параметров могут быть переданы все поля для товара (name, description, article, volume, attr1, attr2, attr3, attr4 и т.д.)
+  * **name** - название товара
+  * **description** - описание товара
+  * **article** - артикул
+  * **enabled** - "0" или "1". признак,что товар активен и незаблокирован
+  * **volume** - объем
+  * **manufacturer_id** - id производителя
+  * **type** - тип товара (G - товар, S - услуга, M - материальная ценность).
+  * **weight_good_flag** - флаг весового товара. Значения "Y" / "N"
+  * **not_show_in_shop** - показывать или нет товар в интернет-витрине и мобильном приложении. Значения: "0" / "1"
+  * **html_template_id** - id шаблона ценника
+  * **category_id** - id товарной категории ("1" - алкоголь / "2" - товары18+ )
+  * **group_ids** - разделенный запятой список из id товарных групп, в которые входит товар
+  * **vat_percent** - ставка НДС
+  * **attribute1**..**attribute15** - значения гибких полей
@@ Строка 131: / Строка 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
@@ Строка 141: / Строка 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 ====
@@ Строка 152: / Строка 194: @@
   * **id** - код товара, данные которого надо обновить
-  * **external_id** - код товара во внешней системе учета (например, в 1С), данные которого надо обновит
+  * **external_id** - код товара во внешней системе учета (например, в 1С), данные которого надо обновить
   * **description** - значение товара, которое нужно обновить. В данном случае это описание. Могут быть (name, article, volume, attr1, attr2, attr3, attr4 и т.д.)