Команды API

Материал из Insales Wiki
Перейти к: навигация, поиск

Введение

API InSales предназначено для доступа к информации магазина из интернет с целью создания собственных приложений, синхронизации с иными складскими и учётными системами и т.п.

API InSales работает через HTTP протокол с использованием (GET/POST/PUT/DELETE) запросов. Данные при обмене передаются в XML-формате или JSON-формате.

Большая часть URL-ей для выполнения операций совпадает с URL-ями из бекофиса Инсейлс. Для того чтобы система поняла, что это запрос к API вконец URL надо добавить '.xml', а в заголовке HTTP запроса установить Content-Type: application/xml.

Для каждой группы объектов: заказов, товаров, категорий и т. д. есть свой URL при помощи которого вы можете управлять соответствующими объектами. Другими словами мы попытались организовать свое API в соответствии с принципами REST, насколько это было возможно.

Про то как подключиться к API вы можете прочитать в разделе "как интегрироваться с InSales".

Если возникли вопросы пишите на partners@insales.ru .

Заготовки под разные языки можно посмотреть здесь https://github.com/InSales .

Категории на складе

Получение списка категорий

Получение информации о категории

Добавление новой категории

Редактирование категории

Удаление категории

Товары

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

Получение информации о товаре

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

Редактирование товара

Удаление товара

Изображения товара

Получение всех изображений

Получение изображения

Добавление изображения

Изменение изображения

Удаление изображения

Модификации товара

Получение всех модификаций товара

Получение модификации

Добавление модификации

Изменение модификации

Удаление модификации

Групповое обновление модификаций

Свойства товара

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

Получение информации о свойстве

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

Изменение свойства

Удаление свойства

Значения свойств

Получение списка значений свойств

Получение информации о значении свойства

Добавление значения свойства

Изменение значения свойства

Удаление значения свойства

Дополнительные поля товара

Получение списка дополнительных полей

Получение информации о дополнительном поле

Добавление дополнительного поля

Изменение дополнительного поля

Удаление дополнительного поля

Значения дополнительных полей товара

Получение списка значений дополнительных полей товара

Получение информации о значении дополнительного поля товара

Добавление значения дополнительного поля товара

Изменение значения дополнительного поля товара

Удаление значения дополнительного поля товара

Сопутствующие товары

Получение списка сопутствующих товаров

Добавление сопутствующего товара

Удаление сопутствующего товара

Аналогичные товары

Получение списка аналогичных товаров

Добавление аналогичных товара

Удаление аналогичных товара

Категории на сайте

Получение списка категорий

Получение информации о категории

Добавление новой категории

Редактирование категории

Удаление категории

Размещение товаров на сайте

Добавление товара в категорию

Удаление товара из категории

Получение списка размещений

Получение списка категорий содержащих товар

Получение списка товаров в категории

Ручная сортировка

Перемещение товара из одной категории в другую

Заказы

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

Получение информации о заказе

Редактирование заказа

Удаление заказа

Получение списка полей для оформления заказа

Получение способов доставки

Получение способов оплаты

Создание заказа

Покупатели

Работа со списком покупателей

Скидки по купонам

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

Получение информации о купоне

Добавление купона

Редактирование купона

Удаление купона

Описание полей

Способы доставки

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

Получение информации

Добавление

Удаление

Способы оплаты

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

Получение информации

Добавление

Удаление

Домены

Работа с доменами

Дополнительные поля адреса и покупателя

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

Получение информации

Добавление

Удаление

Блоги

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

Получение информации

Добавление

Изменение

Удаление

Статьи

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

Получение информации

Добавление

Изменение

Удаление

Файлы

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

Получение файла

Добавление

Удаление

Редиректы

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

Получение редиректа

Добавление

Удаление

Webhooks

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

Получение информации

Добавление

Удаление

Widgets

Суть виджета

Получение списка виджетов

Получение информации о виджете

Добавление виджета

Редактирование виджета

Удаление виджета

Пример реализации виджета

Уведомления пользователя

Что это такое?

Получение списка уведомлений

Добавление уведомления

Удаление уведомления

JsTag

Добавление javascript кода или js файла в магазин

Темы

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

Ассеты

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

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

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

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

Приложения

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

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

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

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

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

Счета

Просмотр

Выставление

Отклонение