Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:itemgroup [12.01.2016 15:42] 127.0.0.1 внешнее изменение |
doc:dev:api:itemgroup [02.06.2018 10:42] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| ====== API :: ItemGroup. Получение/изменение данных о номенклатурных группах ====== | ====== API :: ItemGroup. Получение/изменение данных о номенклатурных группах ====== | ||
| - | В системе реализован программный интерфейс для получения, добавления и изменения данных о группах номенклатуры. Данные выгружаются по http протоколу. Формат на выбор - xml или json. | + | В системе реализован программный интерфейс для получения, добавления и изменения данных о группах номенклатуры. Данные выгружаются по http протоколу. Формат на выбор - XML или JSON. |
| Строка 11: | Строка 11: | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код товара, для которого надо вернуть данные. Если не указан, то возвращаются данные о всех товарных группах. | + | * **id** (get only) - код товарной группы, для которой нужно вернуть данные. Если не указан, то возвращаются данные о всех товарных группах. |
| - | * **external_id** - код товара во внешней системе учета (например, в 1С) | + | * **external_id** (get only) - код товара во внешней системе учета (например, в 1С) |
| Строка 34: | Строка 34: | ||
| <?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
| <root> | <root> | ||
| - | <success>1</success> | + | <success>1</success> |
| - | <type>item_group</type> | + | <type>item_group</type> |
| - | <count>2</count> | + | <count>15</count> |
| - | <item_groups> | + | <item_groups> |
| - | <item_group> | + | <item_group> |
| - | <id>1</id> | + | <id>1</id> |
| - | <external_id>1231</external_id> | + | <external_id>93a478d4-8933-11e4-ab28-005056a7771f</external_id> |
| - | <name>Группа 1</name> | + | <name>Акционный товар</name> |
| - | <parent_id/> | + | <parent_id /> |
| - | <parent_ext_id/> | + | <parent_ext_id /> |
| - | <not_show_in_shop>0</not_show_in_shop> | + | <not_show_in_shop>0</not_show_in_shop> |
| - | <index_tree>1:</index_tree> | + | <index_tree>1:</index_tree> |
| - | <created_date>2015-07-11 17:39:10</created_date> | + | <created_date>2015-07-23 17:33:10</created_date> |
| - | <last_update_date>2015-07-11 17:39:10</last_update_date> | + | <last_update_date>2015-11-18 13:05:55</last_update_date> |
| - | </item_group> | + | </item_group> |
| - | <item_group> | + | <item_group> |
| - | <id>2</id> | + | <id>2</id> |
| - | <external_id>{123-343-23423}</external_id> | + | <external_id>01af7174-8a1f-11e4-ab28-005056a7771f</external_id> |
| - | <name>Группа 2</name> | + | <name>Обычный товар</name> |
| - | <parent_id/> | + | <parent_id /> |
| - | <parent_ext_id/> | + | <parent_ext_id /> |
| - | <not_show_in_shop>0</not_show_in_shop> | + | <not_show_in_shop>0</not_show_in_shop> |
| - | <index_tree>2:</index_tree> | + | <index_tree>2:</index_tree> |
| - | <created_date>2015-07-11 17:39:27</created_date> | + | <created_date>2015-07-23 17:33:10</created_date> |
| - | <last_update_date>2015-07-11 17:39:27</last_update_date> | + | <last_update_date>2015-11-18 13:05:55</last_update_date> |
| - | </item_group> | + | </item_group> |
| + | </item_groups> | ||
| </root> | </root> | ||
| </file> | </file> | ||
| Строка 66: | Строка 67: | ||
| ===== Пример запроса на добавление/изменение данных ===== | ===== Пример запроса на добавление/изменение данных ===== | ||
| - | Пример запроса на получение данных о товарных группах: | + | Пример запроса на изменение данных о товарных группах: |
| http://mycompany.virtpos.ru/api/itemGroup/update?apikey=MySecret&create_if_not_exist=0&external_id=666 | http://mycompany.virtpos.ru/api/itemGroup/update?apikey=MySecret&create_if_not_exist=0&external_id=666 | ||
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **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) - Если истина, то при неудачном поиске товарная группа будет добавлена в систему. |
| - | * Также в качестве параметров могут быть переданы все поля для товарно группы (name, parent_id, external_id, parent_ext_id и т.д.) | + | * Также в качестве параметров могут быть переданы все поля для товарной группы (name, parent_id, external_id, parent_ext_id и т.д.) |
| Строка 105: | Строка 106: | ||
| </file> | </file> | ||
| + | |||
| + | ===== Пример запроса на удаление данных ===== | ||
| + | |||
| + | Пример запроса на удаление товарной группы: | ||
| + | |||
| + | http://mycompany.virtpos.ru/api/itemGroup/delete/?apikey=MySecret&format=xml&id=1 | ||
| + | |||
| + | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| + | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| + | |||
| + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | ||
| + | |||
| + | * **id** (get only) - код товарной группы, которая будет удалена | ||
| + | |||
| + | |||
| + | ==== Ответ сервера ==== | ||
| + | |||
| + | В ответ получаем XML или JSON. В ответе обязательно присутствует поле success. Если success=1, то операция выполнена успешно. Если success=0, то произошла ошибка. Дополнительная информация об ошибке содержится в поле info. | ||
| + | |||
| + | Также возвращается id записи, которая была удалена. | ||
| + | |||
| + | |||
| + | ==== Пример ответа сервера ==== | ||
| + | <file xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <root> | ||
| + | <success>1</success> | ||
| + | <id>1</id> | ||
| + | </root> | ||
| + | </file> | ||