Команды API — различия между версиями
Vt (обсуждение | вклад) (→Widgets) |
(→Введение) |
||
(не показаны 23 промежуточные версии 6 участников) | |||
Строка 3: | Строка 3: | ||
[[Основные определения, применяемые в документации#API|API]] InSales предназначено для доступа к информации магазина из интернет с целью создания собственных приложений, синхронизации с иными складскими и учётными системами и т.п. | [[Основные определения, применяемые в документации#API|API]] InSales предназначено для доступа к информации магазина из интернет с целью создания собственных приложений, синхронизации с иными складскими и учётными системами и т.п. | ||
− | API InSales работает через HTTP протокол с использованием (GET/POST/PUT/DELETE) запросов. Данные при обмене передаются в [http://ru.wikipedia.org/wiki/XML XML формате]. | + | API InSales работает через HTTP протокол с использованием (GET/POST/PUT/DELETE) запросов. Данные при обмене передаются в [http://ru.wikipedia.org/wiki/XML XML-формате] или JSON-формате. |
− | + | Для корректной работы необходимо указывать Content-Type в запросе ('''Content-Type''': '''application/xml''' или '''Content-Type''': '''application/json''' ). | |
Для каждой группы объектов: заказов, товаров, категорий и т. д. есть свой URL при помощи которого вы можете управлять соответствующими объектами. Другими словами мы попытались организовать свое API в соответствии с принципами [http://ru.wikipedia.org/wiki/REST REST], насколько это было возможно. | Для каждой группы объектов: заказов, товаров, категорий и т. д. есть свой URL при помощи которого вы можете управлять соответствующими объектами. Другими словами мы попытались организовать свое API в соответствии с принципами [http://ru.wikipedia.org/wiki/REST REST], насколько это было возможно. | ||
Строка 62: | Строка 62: | ||
[[InSales API - Модификации товара#Удаление модификации|Удаление модификации]] | [[InSales API - Модификации товара#Удаление модификации|Удаление модификации]] | ||
+ | |||
+ | [[InSales API - Модификации товара#Групповое обновление модификаций|Групповое обновление модификаций]] | ||
=Свойства товара= | =Свойства товара= | ||
Строка 86: | Строка 88: | ||
[[InSales API - Значения свойств#Удаление значения свойства|Удаление значения свойства]] | [[InSales API - Значения свойств#Удаление значения свойства|Удаление значения свойства]] | ||
+ | |||
+ | =Дополнительные поля товара= | ||
+ | |||
+ | [[InSales API - Дополнительные поля товара#Получение списка дополнительных полей|Получение списка дополнительных полей]] | ||
+ | |||
+ | [[InSales API - Дополнительные поля товара#Получение информации о дополнительном поле|Получение информации о дополнительном поле]] | ||
+ | |||
+ | [[InSales API - Дополнительные поля товара#Добавление дополнительного поля|Добавление дополнительного поля]] | ||
+ | |||
+ | [[InSales API - Дополнительные поля товара#Изменение дополнительного поля|Изменение дополнительного поля]] | ||
+ | |||
+ | [[InSales API - Дополнительные поля товара#Удаление дополнительного поля|Удаление дополнительного поля]] | ||
+ | |||
+ | =Значения дополнительных полей товара= | ||
+ | |||
+ | [[InSales API - Значения дополнительных полей товара#Получение списка значений дополнительных полей товара|Получение списка значений дополнительных полей товара]] | ||
+ | |||
+ | [[InSales API - Значения дополнительных полей товара#Получение информации о значении дополнительного поля товара|Получение информации о значении дополнительного поля товара]] | ||
+ | |||
+ | [[InSales API - Значения дополнительных полей товара#Добавление значения дополнительного поля товара|Добавление значения дополнительного поля товара]] | ||
+ | |||
+ | [[InSales API - Значения дополнительных полей товара#Изменение значения дополнительного поля товара|Изменение значения дополнительного поля товара]] | ||
+ | |||
+ | [[InSales API - Значения дополнительных полей товара#Удаление значения дополнительного поля товара|Удаление значения дополнительного поля товара]] | ||
=Сопутствующие товары= | =Сопутствующие товары= | ||
Строка 148: | Строка 174: | ||
[[InSales API - Заказы#Создание заказа|Создание заказа]] | [[InSales API - Заказы#Создание заказа|Создание заказа]] | ||
+ | |||
+ | =Покупатели= | ||
+ | |||
+ | [[InSales API - Покупатели|Работа со списком покупателей]] | ||
=Скидки по купонам= | =Скидки по купонам= | ||
Строка 172: | Строка 202: | ||
[[InSales API - Способы доставки#Удаление|Удаление]] | [[InSales API - Способы доставки#Удаление|Удаление]] | ||
+ | |||
+ | =Способы оплаты= | ||
+ | |||
+ | [[InSales API - Способы оплаты#Получение списка|Получение списка]] | ||
+ | |||
+ | [[InSales API - Способы оплаты#Получение информации|Получение информации]] | ||
+ | |||
+ | [[InSales API - Способы оплаты#Добавление|Добавление]] | ||
+ | |||
+ | [[InSales API - Способы оплаты#Удаление|Удаление]] | ||
+ | |||
+ | =Домены= | ||
+ | |||
+ | [[InSales API - Домены|Работа с доменами]] | ||
=Дополнительные поля адреса и покупателя= | =Дополнительные поля адреса и покупателя= | ||
Строка 183: | Строка 227: | ||
[[InSales API - Дополнительные поля#Удаление|Удаление]] | [[InSales API - Дополнительные поля#Удаление|Удаление]] | ||
− | = | + | =Блоги= |
+ | |||
+ | [[InSales API - Блоги#Получение списка|Получение списка]] | ||
+ | |||
+ | [[InSales API - Блоги#Получение информации|Получение информации]] | ||
− | [[InSales API - | + | [[InSales API - Блоги#Добавление|Добавление]] |
− | [[InSales API - | + | [[InSales API - Блоги#Изменение|Изменение]] |
+ | |||
+ | [[InSales API - Блоги#Удаление|Удаление]] | ||
=Статьи= | =Статьи= | ||
Строка 200: | Строка 250: | ||
[[InSales API - Статьи#Удаление|Удаление]] | [[InSales API - Статьи#Удаление|Удаление]] | ||
+ | |||
+ | =Файлы= | ||
+ | |||
+ | [[InSales API - Файлы#Получение списка|Получение списка]] | ||
+ | |||
+ | [[InSales API - Файлы#Получение файла|Получение файла]] | ||
+ | |||
+ | [[InSales API - Файлы#Добавление|Добавление]] | ||
+ | |||
+ | [[InSales API - Файлы#Удаление|Удаление]] | ||
+ | |||
+ | =Редиректы= | ||
+ | |||
+ | [[InSales API - Редиректы#Получение списка|Получение списка]] | ||
+ | |||
+ | [[InSales API - Редиректы#Получение редиректа|Получение редиректа]] | ||
+ | |||
+ | [[InSales API - Редиректы#Добавление|Добавление]] | ||
+ | |||
+ | [[InSales API - Редиректы#Удаление|Удаление]] | ||
=Webhooks= | =Webhooks= | ||
Строка 225: | Строка 295: | ||
[[InSales API - Widgets#Удаление виджета|Удаление виджета]] | [[InSales API - Widgets#Удаление виджета|Удаление виджета]] | ||
− | =Периодическое списание= | + | [[InSales API - Widgets#Пример реализации виджета|Пример реализации виджета]] |
+ | |||
+ | =Уведомления пользователя= | ||
+ | |||
+ | [[InSales API - Уведомления пользователя#Что это такое?|Что это такое?]] | ||
+ | |||
+ | [[InSales API - Уведомления пользователя#Получение списка|Получение списка уведомлений]] | ||
+ | |||
+ | [[InSales API - Уведомления пользователя#Добавление|Добавление уведомления]] | ||
+ | |||
+ | [[InSales API - Уведомления пользователя#Удаление|Удаление уведомления]] | ||
+ | |||
+ | =JsTag= | ||
+ | [[InSales API - js_tag#Создание|Добавление javascript кода или js файла в магазин]] | ||
+ | |||
+ | =Темы= | ||
+ | [[InSales API - Тема#Список тем|Получение списка]] | ||
+ | |||
+ | ==Ассеты== | ||
+ | [[InSales API - Asset#Создание|Добавление ассета]] | ||
+ | |||
+ | [[InSales API - Asset#Обновление|Обновление ассета]] | ||
+ | |||
+ | [[InSales API - Asset#Переименование|Переименование ассета]] | ||
+ | |||
+ | [[InSales API - Asset#Удаление|Удаление ассета]] | ||
+ | |||
+ | =Приложения= | ||
+ | |||
+ | ==Периодическое списание== | ||
[[InSales API - Периодическое списание#Добавление периодического списания|Добавление периодического списания]] | [[InSales API - Периодическое списание#Добавление периодического списания|Добавление периодического списания]] | ||
Строка 234: | Строка 333: | ||
[[InSales API - Периодическое списание#Удаление периодического списания|Удаление периодического списания]] | [[InSales API - Периодическое списание#Удаление периодического списания|Удаление периодического списания]] | ||
+ | |||
+ | ==Счета== | ||
+ | |||
+ | [[InSales API - Счета приложения#Просмотр|Просмотр]] | ||
+ | |||
+ | [[InSales API - Счета приложения#Выставление|Выставление]] | ||
+ | |||
+ | [[InSales API - Счета приложения#Отклонение|Отклонение]] |
Текущая версия на 10:00, 7 декабря 2017
Содержание
- 1 Введение
- 2 Категории на складе
- 3 Товары
- 4 Изображения товара
- 5 Модификации товара
- 6 Свойства товара
- 7 Значения свойств
- 8 Дополнительные поля товара
- 9 Значения дополнительных полей товара
- 10 Сопутствующие товары
- 11 Аналогичные товары
- 12 Категории на сайте
- 13 Размещение товаров на сайте
- 14 Заказы
- 15 Покупатели
- 16 Скидки по купонам
- 17 Способы доставки
- 18 Способы оплаты
- 19 Домены
- 20 Дополнительные поля адреса и покупателя
- 21 Блоги
- 22 Статьи
- 23 Файлы
- 24 Редиректы
- 25 Webhooks
- 26 Widgets
- 27 Уведомления пользователя
- 28 JsTag
- 29 Темы
- 30 Приложения
Введение
API InSales предназначено для доступа к информации магазина из интернет с целью создания собственных приложений, синхронизации с иными складскими и учётными системами и т.п.
API InSales работает через HTTP протокол с использованием (GET/POST/PUT/DELETE) запросов. Данные при обмене передаются в XML-формате или JSON-формате.
Для корректной работы необходимо указывать Content-Type в запросе (Content-Type: application/xml или Content-Type: application/json ).
Для каждой группы объектов: заказов, товаров, категорий и т. д. есть свой URL при помощи которого вы можете управлять соответствующими объектами. Другими словами мы попытались организовать свое API в соответствии с принципами REST, насколько это было возможно.
Про то как подключиться к API вы можете прочитать в разделе "как интегрироваться с InSales".
Если возникли вопросы пишите на partners@insales.ru .
Заготовки под разные языки можно посмотреть здесь https://github.com/InSales .
Категории на складе
Получение информации о категории
Товары
Изображения товара
Модификации товара
Получение всех модификаций товара
Групповое обновление модификаций
Свойства товара
Получение информации о свойстве
Значения свойств
Получение списка значений свойств
Получение информации о значении свойства
Дополнительные поля товара
Получение списка дополнительных полей
Получение информации о дополнительном поле
Добавление дополнительного поля
Изменение дополнительного поля
Значения дополнительных полей товара
Получение списка значений дополнительных полей товара
Получение информации о значении дополнительного поля товара
Добавление значения дополнительного поля товара
Изменение значения дополнительного поля товара
Удаление значения дополнительного поля товара
Сопутствующие товары
Получение списка сопутствующих товаров
Добавление сопутствующего товара
Удаление сопутствующего товара
Аналогичные товары
Получение списка аналогичных товаров
Категории на сайте
Получение информации о категории
Размещение товаров на сайте
Получение списка категорий содержащих товар
Получение списка товаров в категории
Перемещение товара из одной категории в другую
Заказы
Получение списка полей для оформления заказа
Покупатели
Скидки по купонам
Способы доставки
Способы оплаты
Домены
Дополнительные поля адреса и покупателя
Блоги
Статьи
Файлы
Редиректы
Webhooks
Widgets
Получение информации о виджете
Уведомления пользователя
JsTag
Добавление javascript кода или js файла в магазин
Темы
Ассеты
Приложения
Периодическое списание
Добавление периодического списания
Проверка состояния периодического списания
Изменение величины периодического списания
Удаление периодического списания