Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:itemgroup [01.09.2017 14:06] mzubkov [Параметры запроса] |
doc:dev:api:itemgroup [22.10.2025 12:07] (текущий) rlysov [Пример запроса на удаление данных] |
||
|---|---|---|---|
| Строка 8: | Строка 8: | ||
| Пример запроса на получение данных о товарных группах: | Пример запроса на получение данных о товарных группах: | ||
| - | http://mycompany.virtpos.ru/api/itemGroup?apikey=MySecret&format=xml | + | https://[company].myvirtualpos.ru/api/itemGroup?apikey=MySecret&format=xml |
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| Строка 69: | Строка 69: | ||
| Пример запроса на изменение данных о товарных группах: | Пример запроса на изменение данных о товарных группах: | ||
| - | http://mycompany.virtpos.ru/api/itemGroup/update?apikey=MySecret&create_if_not_exist=0&external_id=666 | + | https://[company].myvirtualpos.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 и т.д.) | ||
| Строка 111: | Строка 111: | ||
| Пример запроса на удаление товарной группы: | Пример запроса на удаление товарной группы: | ||
| - | http://mycompany.virtpos.ru/api/itemGroup/delete/?apikey=MySecret&format=xml&id=1 | + | https://[company].myvirtualpos.ru/api/itemGroup/delete/?apikey=MySecret&format=xml&id=1 |
| ==== Параметры запроса ==== | ==== Параметры запроса ==== | ||
| + | параметры, которые не отмечены как **get only**, могут быть переданы как get- или как post-параметры. | ||
| * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | * **apikey** - Секретный ключ для доступа к данным. Обязательный параметр. | ||
| - | * **format** - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. | + | * **format** (get only) - формат, в котором сервер отдаст данные. Может принимать значения "xml" или "json". Необязательный параметр. |
| - | * **id** - код товарной группы, которая будет удалена | + | * **id** (get only) - код товарной группы, которая будет удалена |