Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
doc:dev:api:warehouse [01.09.2017 14:32] mzubkov [Параметры запроса] |
doc:dev:api:warehouse [20.10.2020 12:31] (текущий) sshevchuk [Пример запроса на добавление/изменение данных] |
||
|---|---|---|---|
| Строка 19: | Строка 19: | ||
| * **external_id** (get only) - код магазина во внешней системе учета (например, в 1С) | * **external_id** (get only) - код магазина во внешней системе учета (например, в 1С) | ||
| + | * **fields** - список дополнительных полей, которые будут добавлены в ответ сервера. Имена полей разделены символом ":". Необязательный параметр. Поддерживаются следующие поля: | ||
| + | * organisation_name - название организации | ||
| Строка 50: | Строка 52: | ||
| <lon>37.60998200000000</lon> | <lon>37.60998200000000</lon> | ||
| <minusale>1</minusale> | <minusale>1</minusale> | ||
| + | <show_in_shop>1</show_in_shop> | ||
| <location_id>1</location_id> | <location_id>1</location_id> | ||
| <location_name>Москва</location_name> | <location_name>Москва</location_name> | ||
| Строка 70: | Строка 73: | ||
| <lon>37.84508900000000</lon> | <lon>37.84508900000000</lon> | ||
| <minusale>1</minusale> | <minusale>1</minusale> | ||
| + | <show_in_shop>1</show_in_shop> | ||
| <location_id>1</location_id> | <location_id>1</location_id> | ||
| <location_name>Москва</location_name> | <location_name>Москва</location_name> | ||
| Строка 85: | Строка 89: | ||
| Пример запроса на получение данных о точке продаж: | Пример запроса на получение данных о точке продаж: | ||
| - | http://mycompany.virtpos.ru/api/warehouse/update?apikey=MySecret&create_if_not_exist=0&external_id=666 | + | https://mycompany.myvirtualpos.ru/api/warehouse/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) - Если истина, то при неудачном поиске магазин будет добавлен в систему. |
| - | * **location_name** - Название территории. Если значение указано, то происходит проверка, есть ли территория с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется, если указан location_id | + | * **location_name** (get only) - Название территории. Если значение указано, то происходит проверка, есть ли территория с таким именем в справочнике. Если нет, то она будет добавлена. Параметр игнорируется, если указан location_id |
| * Также в качестве параметров могут быть переданы все поля для магазина (name, address, phone и т.д.) | * Также в качестве параметров могут быть переданы все поля для магазина (name, address, phone и т.д.) | ||