Команды API — различия между версиями

Материал из Insales Wiki
Перейти к: навигация, поиск
(Введение)
(Введение)
 
(не показаны 42 промежуточные версии 9 участников)
Строка 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], насколько это было возможно.
Строка 9: Строка 11:
 
Про то как подключиться к API вы можете прочитать в разделе [[Как интегрироваться с InSales|"как интегрироваться с InSales"]].
 
Про то как подключиться к API вы можете прочитать в разделе [[Как интегрироваться с InSales|"как интегрироваться с InSales"]].
  
На данном этапе API находится в разработке, так что если в API нет методов, которые по логике должны в нем быть, обращайтесь в техническую поддержку.
+
Если возникли вопросы пишите на partners@insales.ru .
 +
 
 +
Заготовки под разные языки можно посмотреть здесь https://github.com/InSales .
  
 
=Категории на складе=
 
=Категории на складе=
Строка 34: Строка 38:
  
 
[[InSales API - Товары#Удаление товара|Удаление товара]]
 
[[InSales API - Товары#Удаление товара|Удаление товара]]
 +
 +
=Изображения товара=
 +
 +
[[InSales API - изображения товаров#Получение всех изображений|Получение всех изображений]]
 +
 +
[[InSales API - изображения товаров#Получение изображения|Получение изображения]]
 +
 +
[[InSales API - изображения товаров#Добавление  изображения|Добавление  изображения]]
 +
 +
[[InSales API - изображения товаров#Изменение изображения|Изменение изображения]]
 +
 +
[[InSales API - изображения товаров#Удаление изображения|Удаление изображения]]
  
 
=Модификации товара=
 
=Модификации товара=
Строка 46: Строка 62:
  
 
[[InSales API - Модификации товара#Удаление модификации|Удаление модификации]]
 
[[InSales API - Модификации товара#Удаление модификации|Удаление модификации]]
 +
 +
[[InSales API - Модификации товара#Групповое обновление модификаций|Групповое обновление модификаций]]
  
 
=Свойства товара=
 
=Свойства товара=
Строка 70: Строка 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 - Значения дополнительных полей товара#Удаление значения дополнительного поля товара|Удаление значения дополнительного поля товара]]
 +
 +
=Сопутствующие товары=
 +
 +
[[Insales API - Сопутствующие товары#Получение списка сопутствующих товаров|Получение списка сопутствующих товаров]]
 +
 +
[[Insales API - Сопутствующие товары#Добавление сопутствующего товара|Добавление сопутствующего товара]]
 +
 +
[[Insales API - Сопутствующие товары#Удаление сопутствующего товара|Удаление сопутствующего товара]]
 +
 +
=Аналогичные товары=
 +
 +
[[Insales API - Аналогичные товары#Получение списка аналогичных товаров|Получение списка аналогичных товаров]]
 +
 +
[[Insales API - Аналогичные товары#Добавление аналогичных товара|Добавление аналогичных товара]]
 +
 +
[[Insales API - Аналогичные товары#Удаление аналогичных товара|Удаление аналогичных товара]]
  
 
=Категории на сайте=
 
=Категории на сайте=
Строка 107: Строка 165:
 
[[InSales API - Заказы#Редактирование заказа|Редактирование заказа]]
 
[[InSales API - Заказы#Редактирование заказа|Редактирование заказа]]
  
[[InSales API - Заказы#Удаление заказа|Удаление категории]]
+
[[InSales API - Заказы#Удаление заказа|Удаление заказа]]
 +
 
 +
[[InSales API - Заказы#Получение списка полей для оформления заказа|Получение списка полей для оформления заказа]]
 +
 
 +
[[InSales API - Заказы#Получение способов доставки|Получение способов доставки]]
 +
 
 +
[[InSales API - Заказы#Получение способов оплаты|Получение способов оплаты]]
 +
 
 +
[[InSales API - Заказы#Создание заказа|Создание заказа]]
 +
 
 +
=Покупатели=
 +
 
 +
[[InSales API - Покупатели|Работа со списком покупателей]]
 +
 
 +
=Скидки по купонам=
 +
 
 +
[[InSales API - Скидки по купонам#Получение списка купонов|Получение списка купонов]]
 +
 
 +
[[InSales API - Скидки по купонам#Получение информации о купоне|Получение информации о купоне]]
 +
 
 +
[[InSales API - Скидки по купонам#Добавление купона|Добавление купона]]
 +
 
 +
[[InSales API - Скидки по купонам#Редактирование купона|Редактирование купона]]
 +
 
 +
[[InSales API - Скидки по купонам#Удаление купона|Удаление купона]]
 +
 
 +
[[InSales API - Скидки по купонам#Описание полей|Описание полей]]
 +
 
 +
=Способы доставки=
 +
 
 +
[[InSales API - Способы доставки#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Способы доставки#Получение информации|Получение информации]]
 +
 
 +
[[InSales API - Способы доставки#Добавление|Добавление]]
 +
 
 +
[[InSales API - Способы доставки#Удаление|Удаление]]
 +
 
 +
=Способы оплаты=
 +
 
 +
[[InSales API - Способы оплаты#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Способы оплаты#Получение информации|Получение информации]]
 +
 
 +
[[InSales API - Способы оплаты#Добавление|Добавление]]
 +
 
 +
[[InSales API - Способы оплаты#Удаление|Удаление]]
 +
 
 +
=Домены=
 +
 
 +
[[InSales API - Домены|Работа с доменами]]
 +
 
 +
=Дополнительные поля адреса и покупателя=
 +
 
 +
[[InSales API - Дополнительные поля#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Дополнительные поля#Получение информации|Получение информации]]
 +
 
 +
[[InSales API - Дополнительные поля#Добавление|Добавление]]
 +
 
 +
[[InSales API - Дополнительные поля#Удаление|Удаление]]
 +
 
 +
=Блоги=
 +
 
 +
[[InSales API - Блоги#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Блоги#Получение информации|Получение информации]]
 +
 
 +
[[InSales API - Блоги#Добавление|Добавление]]
 +
 
 +
[[InSales API - Блоги#Изменение|Изменение]]
 +
 
 +
[[InSales API - Блоги#Удаление|Удаление]]
 +
 
 +
=Статьи=
 +
 
 +
[[InSales API - Статьи#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Статьи#Получение информации|Получение информации]]
 +
 
 +
[[InSales API - Статьи#Добавление|Добавление]]
 +
 
 +
[[InSales API - Статьи#Изменение|Изменение]]
 +
 
 +
[[InSales API - Статьи#Удаление|Удаление]]
 +
 
 +
=Файлы=
 +
 
 +
[[InSales API - Файлы#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Файлы#Получение файла|Получение файла]]
 +
 
 +
[[InSales API - Файлы#Добавление|Добавление]]
 +
 
 +
[[InSales API - Файлы#Удаление|Удаление]]
 +
 
 +
=Редиректы=
 +
 
 +
[[InSales API - Редиректы#Получение списка|Получение списка]]
 +
 
 +
[[InSales API - Редиректы#Получение редиректа|Получение редиректа]]
 +
 
 +
[[InSales API - Редиректы#Добавление|Добавление]]
 +
 
 +
[[InSales API - Редиректы#Удаление|Удаление]]
  
 
=Webhooks=
 
=Webhooks=
Строка 118: Строка 280:
  
 
[[InSales API - Webhooks#Удаление|Удаление]]
 
[[InSales API - Webhooks#Удаление|Удаление]]
 +
 +
=Widgets=
 +
 +
[[InSales API - Widgets#Суть виджета|Суть виджета]]
 +
 +
[[InSales API - Widgets#Получение списка виджетов|Получение списка виджетов]]
 +
 +
[[InSales API - Widgets#Получение информации о виджете|Получение информации о виджете]]
 +
 +
[[InSales API - Widgets#Добавление виджета|Добавление виджета]]
 +
 +
[[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 - Периодическое списание#Проверка состояния периодического списания|Проверка состояния периодического списания]]
 +
 +
[[InSales API - Периодическое списание#Изменение величины периодического списания|Изменение величины периодического списания]]
 +
 +
[[InSales API - Периодическое списание#Удаление периодического списания|Удаление периодического списания]]
 +
 +
==Счета==
 +
 +
[[InSales API - Счета приложения#Просмотр|Просмотр]]
 +
 +
[[InSales API - Счета приложения#Выставление|Выставление]]
 +
 +
[[InSales API - Счета приложения#Отклонение|Отклонение]]

Текущая версия на 10:00, 7 декабря 2017

Введение

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 файла в магазин

Темы

Получение списка

Ассеты

Добавление ассета

Обновление ассета

Переименование ассета

Удаление ассета

Приложения

Периодическое списание

Добавление периодического списания

Проверка состояния периодического списания

Изменение величины периодического списания

Удаление периодического списания

Счета

Просмотр

Выставление

Отклонение