документацию по API v1.3

реклама
Документация по API v1.3
Док уме нтация › API
Описание API v1.3:
Загрузка и выгрузка данных с использованием API осуществляется при помощи GET запросов. Вывод информации в формате
JSON.
АПИ берет данные по guid, то есть если добавлять номенклатуру и в запросе указать category с guid несуществуещей категории в
базе, метод вернет ошибку.
Все цены с копейками добавляются через точку. Пример: Сто рублей три копейки будет равен 100.03
Порядок добавление данных
1
Валюта
2
Тип ц ены
3
Пользователи
4
Категории
5
Номенклатура
6
Название характеристик
7
Характеристики
8
Цены
9
Остаток
10
Заказы
Список методов:
№
Название метода
Назначение метода
1
add_currency
Добавление валюты
2
currency
Вывод информац ии о валюте
3
del_currency
Удаление валюты
Валюта
Номенклатура
4
add_product
Добавление номенклатуры
5
products
Вывод информац ии о номенклатуре
6
del_product
Удаление номенклатуры
7
add_category
Добавление категорий
8
category
Вывод информац ии о категориях
9
del_category
Удаление категорий
Категории
Наверх
Пользователи
10
add_user
Добавление пользователя
11
users
Вывод информац ии о пользователях
12
password
Изменение пароля
13
balance
Изменение баланса
14
del_user
Удаление пользователя
15
add_type
Добавление типа ц ены
16
type
Вывод типа ц ены
17
del_type
Удаление типа ц ены
Тип цен
Характеристики
18
add_char
Добавление характеристики
19
char
Вывод характеристики
20
del_char
Удаление характеристики
21
add_char_prop
Добавление свойств характеристик
22
char_prop
Вывод свойств характеристик
23
del_char_prop
Удаление свойств характеристик
Свойства характеристик
Типов свойств характеристик
24
add_char_type
Добавление типов свойств характеристик
25
char_type
Вывод типов свойств характеристик
26
del_char_type
Удаление типов свойств характеристик
27
add_remain
Добавление остатка
28
remain
Вывод остатков
29
del_remain
Удаление остатка
30
add_graph
Добавление кол-ва остатка
31
graph
Вывод кол-ва остатков
32
del_graph
Удаление кол-ва остатка
Остаток
Цены
33
add_price
Добавление ц ен
34
prices
Вывод ц ен
35
del_price
Удаление всех ц ен
36
add_order_main
Добавление общ его заказа
37
add_order
Добавление подробного заказа
38
orders
Вывод заказов
39
order_guid
Задать Guid заказу
40
del_order
Удаление заказов по guid
Заказы
Настройки
41
add_setting
Добавление или изменение настроек
42
setting
Вывод настроек
О компании
41
add_company
Изменение информац ии о компании
42
company
Вывод информац ии о компании
Изображения номенклатуры
43
add_image
Загрузка изображ ения номенклатуры
44
images
Вывод информац ии о изображ ениях
45
del_image
Удаление изображ ений
46
add_manager
Добавление менедж ера к пользователю
47
managers
Вывод информац ии о менедж ерах
48
del_manager
Удаление менедж ера
Изображения номенклатуры
Метод add_currency
Данный метод осуществляет добавление валюты.
Список параметров:
name - Название
rate - Курс
guid - GUID валюты
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
name
Обозначение валюты
rate
Курс валюты
guid
Guid валюты
Пример использование метода:
http://demo.profishop.us/api/add_currency?name=Обозначение&rate=Курс&guid=Guid_валюты
Метод currency
Данный метод осуществляет вывод информации о валюте или вывод всех валют.
Список параметров:
guid - GUID валюты
Важно: Если параметр guid не передан будут выведены ВСЕ валюты.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid валюты
Существуют два принципа использования:
1. Вывод всех валют: http://demo.profishop.us/api/currency
2. Вывод валюты по guid: http://demo.profishop.us/api/currency?guid=GUID
Метод del_currency
Данный метод осуществляет удаление валюты или удаление всех валют.
Список параметров:
guid - GUID валюты
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid валюты или all для удаления всех валют
Существуют два принципа использования:
1. Удаление всех валют: http://demo.profishop.us/api/del_currency?guid=all
2. Удаление валюты по guid: http://demo.profishop.us/api/del_currency?guid=GUID
Метод add_product
Данный метод осуществляет добавление номенклатуры.
Список параметров:
name - Название
articule - Артикул
category - GUID категории
guid - GUID номенклатуры
status - Статус(0 - выкл., 1 - вкл.)
unit - Размерность
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
name
Название номенклатуры
articule
Артикул номенклатуры
category
Guid категории
guid
Guid номенклатуры
status
Статус, 0 или 1.
unit
Размерность(шт., кг., см. и т.д.)
Пример использование метода:
http://demo.profishop.us/api/add_product?
name=Название&articule=Артикул&category=Guid_категории&guid=Guid_номенклатуры&status=Статус&unit=Размерность
Метод products
Данный метод осуществляет вывод информации о номенклатуре или вывод всех номенклатур.
Список параметров:
guid - GUID номенклатуры
Важно: Если параметр guid не передан будут выведены ВСЕ номенклатуры.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid номенклатуры
Существуют два принципа использования:
1. Вывод всех номенклатур: http://demo.profishop.us/api/products
2. Вывод номенклатуры по guid: http://demo.profishop.us/api/products?guid=GUID
Метод del_product
Данный метод осуществляет удаление номенклатуры или удаление всех номенклатур.
Список параметров:
guid - GUID номенклатуры
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid номенклатуры или all для удаления всех номенклатур
Существуют два принципа использования:
1. Удаление всех номенклатур: http://demo.profishop.us/api/del_product?guid=all
2. Удаление номенклатуры по guid: http://demo.profishop.us/api/del_product?guid=GUID
Метод add_category
Данный метод осуществляет добавление категории и подкатегорий.
Список параметров:
name - Название
parent - Подкатегория, если нет равно 0
guid - GUID категории
status - Статус(0 - выкл., 1 - вкл.)
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
name
Название категории
parent
Guid подкатегории товара, либо 0 если подкатегории нет
guid
Guid категории
status
Статус, 0 или 1.
Пример использование метода:
http://demo.profishop.us/api/add_category?
name=Название&parent=Guid_подкатегории&guid=Guid_категории&status=Статус
Метод category
Данный метод осуществляет вывод информации о категории или вывод всех категорий.
Список параметров:
guid - GUID категории
Важно: Если параметр guid не передан будут выведены ВСЕ категории.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid категории
Существуют два принципа использования:
1. Вывод всех категорий: http://demo.profishop.us/api/category
2. Вывод категории по guid: http://demo.profishop.us/api/category?guid=GUID
Метод del_category
Данный метод осуществляет удаление категории или удаление всех категорий.
Список параметров:
guid - GUID номенклатуры
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid категории или all для удаления всех категорий
Существуют два принципа использования:
1. Удаление всех категорий: http://demo.profishop.us/api/del_category?guid=all
2. Удаление категории по guid: http://demo.profishop.us/api/del_category?guid=GUID
Метод add_user
Данный метод осуществляет добавление пользователей.
Список параметров:
login - Логин
pass - Пароль
guid - GUID пользователя
type_of_price_guid - Тип цены пользователя
balance - Баланс пользователя
ur_add - Юридический адрес
fact_add - Фактический адрес
inn - ИНН
kpp - КПП
phone - Телефон
korr_schet - Счет какой то
bank - Банк
bik - Банк
ras_sch - Расчетный счет
email - Электронная почта
site - Ссылка на сайт
name - Ф.И.О.
manager - тип пользователя (1 если менеджер, 0 если пользователь)
Важно: Параметры login, pass, guid, type_of_price_guid являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных
параметров метод вернет ответ "Отсутствуют данные!"
Использование:
Пример использование метода:
http://demo.profishop.us/api/add_user?
login=login&pass=pass&guid=guid&type_of_price_guid=type&balance=100.02&ur_add=ur_add&fact_add=fact_add&inn=inn&kpp=kpp&p
Метод users
Данный метод осуществляет вывод информации о пользователи или вывод всех пользователей.
Список параметров:
guid - GUID пользователя
login - Логин пользователя
Важно: Если параметр guid или login не передан будут выведены ВСЕ пользователи.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid пользователя
login
Логин пользователя
Существуют три принципа использования:
1. Вывод всех пользователей: http://demo.profishop.us/api/users
2. Вывод пользователя по guid: http://demo.profishop.us/api/users?guid=GUID
2. Вывод пользователя по логину: http://demo.profishop.us/api/users?login=LOGIN
Метод password
Данный метод осуществляет смену пароля у пользователя.
Список параметров:
guid - GUID пользователя
password - Новый пароль
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
guid
Guid пользователя
password
Пароль пользователя
Пример использование метода:
http://demo.profishop.us/api/password?guid=GUID&password=Пароль
Метод balance
Данный метод осуществляет смену баланса у пользователя.
Список параметров:
guid - GUID пользователя
balance - Баланс
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
guid
Guid пользователя
balance
Баланс пользователя
Пример использование метода:
http://demo.profishop.us/api/balance?guid=GUID&balance=232.05
Метод del_user
Данный метод осуществляет удаление пользователя или удаление всех пользователей.
Список параметров:
guid - GUID пользователя
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid пользователя или all для удаления всех пользователей
Существуют два принципа использования:
1. Удаление всех пользователей: http://demo.profishop.us/api/del_user?guid=all
2. Удаление пользователя по guid: http://demo.profishop.us/api/del_user?guid=GUID
Метод add_type
Данный метод осуществляет добавление типа цены.
Список параметров:
name - Название
valuta - GUID валюты
guid - GUID типа цены
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
name
Название
valuta
Guid валюты
guid
Guid типа ц ены
Пример использование метода:
http://demo.profishop.us/api/add_type?name=Название&valuta=GUID_валюты&guid=guid
Метод type
Данный метод осуществляет вывод информации о типах цен или вывод всех типов цен.
Список параметров:
guid - GUID типа цены
Важно: Если параметр guid не передан будут выведены ВСЕ типы цен.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid типа ц ены
Существуют два принципа использования:
1. Вывод всех типов цен: http://demo.profishop.us/api/type
2. Вывод типа цены по guid: http://demo.profishop.us/api/type?guid=GUID
Метод del_type
Данный метод осуществляет удаление типа цены или удаление всех типов цен.
Список параметров:
guid - Guid типа цены
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid типа ц ены или all для удаления всех типов ц ен
Существуют два принципа использования:
1. Удаление всех типов цен: http://demo.profishop.us/api/del_type?guid=all
2. Удаление типа цены по guid: http://demo.profishop.us/api/del_type?guid=GUID
Метод add_char
Данный метод осуществляет добавление характеристики.
Список параметров:
guid - GUID характеристики
property - GUID свойства характеристики
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
property
GUID свойства характеристики
guid
Guid характеристики
Пример использование метода:
http://demo.profishop.us/api/add_char?property=Guid_property&guid=guid
Метод char
Данный метод осуществляет вывод информации о характеристики или вывод всех характеристик.
Список параметров:
guid - GUID характеристики
Важно: Если параметр guid не передан будут выведены ВСЕ характеристики.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid характеристики
Существуют два принципа использования:
1. Вывод всех характеристик: http://demo.profishop.us/api/char
2. Вывод характеристики по guid: http://demo.profishop.us/api/char?guid=GUID
Метод del_char
Данный метод осуществляет удаление характеристики или удаление всех характеристик.
Список параметров:
guid - Guid характеристики
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid характеристики или all для удаления всех характеристик
Существуют два принципа использования:
1. Удаление всех характеристик: http://demo.profishop.us/api/del_char?guid=all
2. Удаление характеристики по guid: http://demo.profishop.us/api/del_char?guid=GUID
Метод add_char_prop
Данный метод осуществляет добавление свойств характеристик.
Список параметров:
name - Название характеристики
char_type - Guid Тип свойства
guid - GUID
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ
Использование:
Описание параметров:
Параметр
Описание
name
Название
char_type
Guid Тип свойства
guid
Guid
Пример использование метода:
http://demo.profishop.us/api/add_char_prop?name=Название1&char_type=Guid_type_char&guid=guid
Метод char_prop
Данный метод осуществляет вывод информации о свойствах характеристик или вывод всех свойств характеристик.
Список параметров:
guid - GUID свойства характеристик
Важно: Если параметр guid не передан будут выведены ВСЕ свойства характеристик.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid свойства характеристик
Существуют два принципа использования:
1. Вывод всех характеристик: http://demo.profishop.us/api/char_prop
2. Вывод характеристики по guid: http://demo.profishop.us/api/char_prop?guid=GUID
Метод del_char_prop
Данный метод осуществляет удаление свойств характеристик или удаление всех свойств характеристик.
Список параметров:
guid - Guid свойства характеристики
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid свойства характеристики или all для удаления всех свойств характеристик
Существуют два принципа использования:
1. Удаление всех названий характеристик: http://demo.profishop.us/api/del_char_prop?guid=all
2. Удаление названия характеристики по guid: http://demo.profishop.us/api/del_char_prop?guid=GUID
Метод add_char_type
Данный метод осуществляет добавление типа свойств характеристик.
Список параметров:
name - Название типа характеристики
guid - GUID
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ
Использование:
Описание параметров:
Параметр
Описание
name
Название
guid
Guid
Пример использование метода:
http://demo.profishop.us/api/add_char_type?name=Название&guid=guid
Метод char_type
Данный метод осуществляет вывод информации о типе свойств характеристик или вывод всех типов свойств характеристик.
Список параметров:
guid - GUID свойства характеристик
Важно: Если параметр guid не передан будут выведены ВСЕ свойства характеристик.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid свойства характеристик
Существуют два принципа использования:
1. Вывод всех характеристик: http://demo.profishop.us/api/char_type
2. Вывод характеристики по guid: http://demo.profishop.us/api/char_type?guid=GUID
Метод del_char_type
Данный метод осуществляет удаление типа свойств характеристик или удаление всех типов свойств характеристик.
Список параметров:
guid - Guid типа свойства характеристики
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid типа свойства характеристики или all для удаления всех свойств характеристик
Существуют два принципа использования:
1. Удаление всех названий характеристик: http://demo.profishop.us/api/del_char_type?guid=all
2. Удаление названия характеристики по guid: http://demo.profishop.us/api/del_char_type?guid=GUID
Метод add_remain
Данный метод осуществляет добавление остатка.
Список параметров:
remain - Остаток(число)
product - GUID номенклатуры
char - GUID характеристики
Важно: Все параметры, кроме char являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ
"Отсутствуют данные!"
Использование:
Описание параметров:
Параметр
Описание
remain
Остаток, число
product
Guid номенклатуры
char
Guid характеристики или 0 если ее нет или мож но оставить пустым
Пример использование метода:
http://demo.profishop.us/api/add_remain?remain=100&product=Guid_номенклатуры&char=Guid_характеристики
Метод remain
Данный метод осуществляет вывод информации о всех остатках.
Список параметров:
Отстутствуют
Использование:
Пример использование метода: http://demo.profishop.us/api/remain
Метод del_remain
Данный метод осуществляет удаление всех остатков.
Список параметров:
guid - Guid, т.к. данный параметр отсутствует у остатков, он применяется только чтобы удалить все остатки
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid, т.к. данный параметр отсутствует у остатков, он применяется только чтобы удалить все остатки
Пример использование метода: http://demo.profishop.us/api/del_remain?guid=all
Метод add_graph
Данный метод осуществляет добавление кол-ва остатка.
Список параметров:
number - Число от 1 до 10
max - максимальное значение
min - минимальное значение
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
number
Число от 1 до 10
max
максимальное значение
min
минимальное значение
Пример использование метода:
http://demo.profishop.us/api/add_graph?number=1&max=0&min=9
Метод graph
Данный метод осуществляет вывод информации о всех кол-вах остатках.
Список параметров:
Отстутствуют
Использование:
Пример использование метода: http://demo.profishop.us/api/graph
Метод del_graph
Данный метод осуществляет удаление всех кол-в остатков.
Список параметров:
guid - Guid, т.к. данный параметр отсутствует у остатков, он применяется только чтобы удалить все кол-ва остатки
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid, т.к. данный параметр отсутствует у остатков, он применяется только чтобы удалить все кол-в остатки
Пример использование метода: http://demo.profishop.us/api/del_graph?guid=all
Метод add_price
Данный метод осуществляет добавление цены.
Список параметров:
price - Цена
product - GUID номенклатуры
type - GUID типа цены
valuta - GUID валюты
char - GUID характеристики
Важно: Все параметры, кроме char являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ
"Отсутствуют данные!"
Использование:
Описание параметров:
Параметр
Описание
price
Цена
product
Guid номенклатуры
type
Guid типа ц ены
valuta
Guid валюты
char
Guid характеристики, если не будет указан, то выставиться 0, то есть без характеристики
Пример использование метода:
http://demo.profishop.us/api/add_price?
price=150&product=GUID_номенклатуры&type=GUID_ТипЦены&valuta=GUID_Валюта&char=GUID_CHAR
Метод prices
Данный метод осуществляет вывод всех цен.
Список параметров:
ОТСУТСТВУЮТ
Использование:
1. Вывод всех цен: http://demo.profishop.us/api/prices
Метод del_price
Данный метод осуществляет удаление всех цен.
Список параметров:
guid - Guid, т.к. данный параметр отсутствует у цен, он применяется только чтобы удалить все цены
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid, т.к. данный параметр отсутствует у ц ен, он применяется только чтобы удалить все ц ены
Пример использование метода: http://demo.profishop.us/api/del_price?guid=all
Метод add_order_main
Данный метод осуществляет добавление общего заказа. По данному заказу - добавляется более подробные заказы(какая
номенклатура, какая характеристика, какое кол-во и т.д.)
Список параметров:
guid - guid общего заказа
user - GUID пользователя
comment - Комментарий
status - Статус 0 или 1
price - Общая цена заказа
manager - Guid менеджера, если нету то пусто или 0
Важно: Все параметры, кроме comment являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет
ответ "Отсутствуют данные!"
Использование:
Описание параметров:
Параметр
Описание
guid
guid общ его заказа, служ ит для добавления подробностей о заказе
user
Guid пользователя
comment
Комментарий к заказу
status
Статус 0 или 1
price
Общ ая ц ена заказа
Пример использование метода:
http://demo.profishop.us/api/add_order_main?
guid=Guid&user=Guid_пользователя&comment=Комментарий&status=0_или_1&price=Общая_цена&manager=guid
Метод add_order
Данный метод осуществляет добавление заказов по guid общего заказа.
Список параметров:
order - guid общего заказа, который мы добавили в методе add_order_main
product - Комментарий
price - Общая цена заказа
number - Количество заказаной номенклатуры
char - GUID характеристики
Важно: Все параметры, кроме char являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ
"Отсутствуют данные!"
Использование:
Описание параметров:
Параметр
Описание
order
guid общ его заказа, который мы добавили в методе add_order_main
product
Guid номенклатуры
price
Общ ая ц ена заказа
number
Количество заказаной номенклатуры
char
Guid пользователя
Пример использование метода:
http://demo.profishop.us/api/add_order?
order=Guid_общего_заказа&product=Guid_номенклатуры&price=Цена&number=Кол-во&char=Guid_характеристики
Метод orders
Данный метод осуществляет вывод короткой информации о заказе и вывод полный информации о заказе.
Список параметров:
id - Идентификатор заказа
last - All или число для вывода кол-ва последних необработанных заказов
Важно: Если параметр id не передан, будет выведет короткий список всех заказов.
Использование:
Описание параметров:
Параметр
Описание
id
Идентификатор заказа, который мож но получить открыв весь список заказов
last
Guid последнего просмотреного заказа, если данный guid не найдет, система выведет 30 заказов с начала.
Существуют три принципа использования:
1. Вывод всех заказов: http://demo.profishop.us/api/orders
2. Вывод необработанных заказов: http://demo.profishop.us/api/orders?last=all
3. Вывод подробностей о заказе по id: http://demo.profishop.us/api/orders?id=Идентификатор
Структура JSON ответа при выводе информации по id:
Параметр
Описание
order_guid
Guid заказа
full_price
Полная ц ена заказа
date
Дата и время заказа
comment
Комментарий к заказу
user_guid
Guid контрагента
manager_guid
Guid менедж ера ( если заказ сделан не контрагентом ,а его менедж ером)
rows
Подробные данные о заказе
product_guid
Guid номенклатуры
price
Цена номенклатуры
number
Количество заказаной номенклатуры
char_guid
Guid характеристики
Метод order_guid
Данный метод задает guid заказу, у которого еще нет guid
Список параметров:
id - ID заказа
guid - Guid заказа, который мы задаем
Важно: Все параметры ОБЯЗАТЕЛЬНЫЕ.
Использование:
Описание параметров:
Параметр
Описание
id
ID заказа, которому мы выстявляем Guid
guid
Guid заказа, который мы задаем
Пример использование метода: http://demo.profishop.us/api/order_guid?id=12345&guid=GUID_заказа
Метод del_order
Данный метод осуществляет удаление общего заказа и всех подробных заказов по guid и удаление всех заказов
Список параметров:
guid - Guid заказа или all для удаления всех заказов
Важно: Параметр guid ОБЯЗАТЕЛЬНЫЙ.
Использование:
Описание параметров:
Параметр
Описание
guid
Guid заказа
Пример использование метода: http://demo.profishop.us/api/del_order?guid=GUID_заказа
Для удаления всех заказов: http://demo.profishop.us/api/del_order?guid=all
Метод add_setting
Данный метод осуществляет добавление или изменение настроек
Список названий настроек:
help - Ссылка на страницу справки
services - Ссылка на страницу доставки
link_for_client_logo - Ссылка логотипа заказчика
show_char - 0 не показывать, 1 показывать
show_graph - 0 показыть цифрами, 1 показывать картинками
Список параметров:
name - название настройки
option - значение настройки
Использование:
Пример использование метода: http://demo.profishop.us/api/add_setting?name=help&option=www.google.com
Метод add_company
Данный метод осуществляет изменение информации о компании
Список параметров:
name - название
address - адрес
director - Ф.И.О директора
inn - инн
kpp - кпп
guid - гуид
rasch_schet - расчетный счет
bank_name - название банка
bik - бик
korr_schet - кор счет
contact_email - емаил
site - сайт
phone - телефон
slogan - слоган
Использование:
Пример использование метода: http://demo.profishop.us/api/add_company?
name=name&address=Адрес&director=ФИО&inn=ИНН&kpp=КПП&guid=www.google.com&rasch_schet=счет&bank_name=банк&bik=бик
Метод add_image
Данный метод осуществляет загрузку изображений номенклатуры.
Данные посылаются через POST запрос!
Список параметров:
uploadfile - Отправляемый файл
guid - GUID изображения
product - GUID номенклатуры
name - Описание к изображению
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
uploadfile
Отправляемый файл
guid
Guid изображ ения
product
Guid номенклатуры
name
Описание к изображ ению
Метод images
Данный метод осуществляет вывод информации о всех изображениях
Список параметров:
Отсутствуют
Использование:
Пример: http://demo.profishop.us/api/images
Метод del_image
Данный метод осуществляет удаление всех изображений номенклатуры.
Список параметров:
guid - ALL для удаления всех
Использование:
Описание параметров:
Параметр
Описание
guid
all для удаления всех изображ ений
Использование:
Пример использование метода: http://demo.profishop.us/api/del_image?guid=all
Метод add_manager
Данный метод осуществляет добавление менеджера к пользователю.
Список параметров:
user - GUID пользователя
manager - GUID менеджера
Важно: Все параметры являются ОБЯЗАТЕЛЬНЫМИ. При отсутствие обязательных параметров метод вернет ответ "Отсутствуют
данные!"
Использование:
Описание параметров:
Параметр
Описание
user
GUID пользователя
manager
GUID менедж ера
Использование:
Пример использование метода: http://demo.profishop.us/api/add_manager?user=guid&manager=guid
Метод managers
Данный метод осуществляет вывод информации о менеджерах
Список параметров:
Отсутствуют
Использование:
Пример: http://demo.profishop.us/api/managers
Метод del_manager
Данный метод осуществляет удаление всех менеджеров
Список параметров:
guid - ALL для удаления всех
Использование:
Описание параметров:
Параметр
Описание
guid
all для удаления всех менедж еров
Использование:
Пример использование метода: http://demo.profishop.us/api/del_manager?guid=all
Api v1.3 системы Profishop.
Скачать