Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

  • Товарные категории – создавать, изменять, выполнять пакетную загрузку без построения дерева, применять загруженные изменения и формировать дерево категорий, а также удалять категории.
  • Товары – создавать, изменять, удалять и искать товары, устанавливать цены в торговом объекте и загружать изображения на товар.
  • Торговые объекты – создавать, изменять, искать и удалять торговые объекты.
  • Локации – создавать, изменять, искать и удалять локации.

В этой статье описаны основные операции API для работы с товарными категориями, товарами, ценами и ценами. Подробные параметры методов, кампаниями. В статье приведены назначение методов и основные сценарии работы. Полный состав полей, типы данных, ограничения, обязательность параметров, структуры запросов и ответов приведены см. в актуальной Swagger-документации соответствующей версии API.

Операции с торговыми объектами и локациями здесь не рассматриваются. Подробное описание соответствующих методов приведено в Swagger-документации.

Примечание. Перед настройкой интеграции используйте документацию, соответствующую версии СуперМаг DSПримечание. API развивается, поэтому состав методов, параметры и структуры данных могут изменяться. Перед настройкой интеграции сверяйтесь с актуальной Swagger-документацией.

2. Доступ к API

2.1. Доступ к личному кабинету СуперМаг DS 

...

Для создания новой категории или изменения существующей выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/category/{code}

  • partnerId – идентификатор партнёра.
  • code – код категории.

Метод позволяет:

  1. Создать новую категорию товаров.
  2. Обновить данные существующей категории товаров.

...

Для удаления категории выполните DELETE-запрос: 

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/category/{categoryId}

  • partnerId – идентификатор партнёра.
  • categoryId – идентификатор категории. 

...

Для загрузки большого количества категорий за один сценарий обмена выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/category/batch-load

  • partnerId – идентификатор партнёра.

...

После завершения пакетной загрузки необходимо применить загруженные данные – выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/category/commit

  • partnerId – идентификатор партнёра.

...

Для создания нового товара или изменения существующего выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/good/{sku}

  • partnerId – идентификатор партнёра.
  • sku – идентификатор товара.

...

Для того чтобы установить цену на товар в выбранном торговом объекте выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/good/{sku}/location/{locationCode}/price

  • partnerId – идентификатор партнёра.
  • sku – идентификатор товара.
  • locationCode - идентификатор торгового объекта.

Метод позволяет обновить данные существующего товара по его SKU для конкретного торгового объекта, включая цену, PLU (номер на весах), QR-код и параметры кампании.

4.3.1. Передача данных кампании 

При изменении цены для товара в торговом объекте можно передать параметры кампании. 

Кампания определяет ценовые данные товара и используется при выборе подходящей формы отображения. Поддерживаются следующие варианты кампаний:

1. Шаблон 1, Шаблон 2, Шаблон 3: позволяют использовать разные варианты оформления регулярной или акционной цены.

  • Для кампаний доступны поля: Цена, Старая цена и Скидка.

2. Скидка на N-й товар: позволяет задать специальные условия для определённой по счёту единицы товара.

  • Передаются количество товара, скидка, основная цена и цена для N-й единицы.

3. N по цене M: позволяет задать условие, при котором количество N продаётся по стоимости количества M.

  • Передаются количество и цена для соответствующих значений N и M.

4. Скидка от количества: позволяет задавать разные цены в зависимости от количества товара.

  • Для одной кампании можно передать несколько пар Количество – Цена.

Состав передаваемых параметров зависит от типа кампании. Передавайте только данные, предусмотренные для выбранного варианта.

После обработки запроса кампания сохраняется для указанного товара и торгового объекта. Тип кампании и заполненные ценовые поля используются при выборе подходящей формы из активного набора.

Точные системные значения типов кампаний, структура объекта extension, названия и типы полей, обязательность параметров и примеры запросов приведены в Swagger-документации. 

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

Для того чтобы загрузить изображение для товара выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/good/{sku}/image/{name}

  • partnerId – идентификатор партнёра.
  • sku – идентификатор товара.
  • name – имя изображения.

...

Для того чтобы найти товар по названию или sku выполните POST-запрос:

{Внешний адрес сервера}/partner/{partnerId}/api/2.0/good/query

  • partnerId – идентификатор партнёра.

...