Экспорт данных





Целью создания функционала экспорта является предоставление данных о товарных позициях и складских остатках, для автоматизированной обработки. Это позволит вам получить наш каталог товаров на вашем сайте, а цены и остатки будут обновляться автоматически.

Начало работы

Для начала работы, вам потребуется авторизационный ключ (API_KEY). Получить его можно в личном кабинете, после регистрации.
API_KEY выдается на юр.лицо, поэтому, после регистрации, необходимо указать данные вашей организации. На каждую организацию выдается 1 ключ.

Следующим шагом станет формирование вашего ассортимента из нашего каталога. Для этого необходимо перейти по ссылке "Настроить категории", в строке рядом с полученным API_KEY. На этом этапе, вам нужно указать категории товаров из нашего каталога, с которыми вы планируете в дальнейшем работать. По умолчанию, ни одна из категорий не выбрана, поэтому при попытке получить данные без указания категорий, система ответит кодом ошибки 406. Смотреть все коды ошибок.

Получить данные можно в формате JSON и в формате CSV (открывается с помощью MS Excel). Вы можете использовать любой из них, в зависимости от ваших предпочтений, различия между ними - не существенны. Выбор формата осуществляется через параметр в запросе.


Список товаров в формате JSON

Данные возвращаются в кодировке UTF8.
Для получения данных, нужно отправить GET запрос на адрес:

https://slavyanochka-rukodelnica.ru/api/products/API_KEY.json

Результат успешного запроса - JSON представление списка товаров:

{
  "created": int,
  "categories":
    [
      {
        "id": int,
        "name": "string",
        "parent": int
      },
      ...
    ],
  "brands":
    [
      {
        "id": int,
        "name": "string",
      },
      ...
    ],
  "items":
    [
      {
        "id": int,
        "sku": "string",
        "name": "string",
        "size": "string" || null,
        "base_price": int,
        "user_price": int,
        "created": int,
        "available": bool,
        "category1": int,
        "category2": int,
        "category3": int,
        "brand": int,
        "img": "string"
      },
      ...
    ]
}
Описание параметров:
Параметр Тип Значение
created int Время создания документа в формате Unixtimestamp. По этому параметру можно отслеживать изменения документа
categories array Массив товарных категорий (дерево категорий)
categories.id int ID категории
categories.name string Наименование категории
categories.parent int ID родительской категории
brands array Массив данных о производителях
brands.id int ID производителя
brands.name string Наименование производителя
items array Массив данных о товарах
items.id int ID товара
items.sku string Артикул товара (уникальный)
items.name string Наименование товара
items.size string || null Размер товара в произвольном формате. Указывается не для всех типов товаров и тогда возвращается null
items.base_price int Базовая цена товара. Обычная цена, по которой мы осуществляем продажу. Цена указана в копейках
items.user_price int Ваша цена. Базовая цена товара с учетом вашей скидки на этот товар. Если у вас нет скидки на этот товар, то цена будет равна base_price. Цена указана в копейках
items.created int Время создания товара в формате Unixtimestamp
items.available bool Наличие товара
items.category1 int ID категории 1 уровня. Данные о категории можно найти в этом же документе в массиве categories
items.category2 int ID категории 2 уровня. Данные о категории можно найти в этом же документе в массиве categories
items.category3 int ID категории 3 уровня. Данные о категории можно найти в этом же документе в массиве categories
items.brand int ID производителя. Данные о производителе можно найти в этом же документе в массиве brands
items.img string URL адрес изображения товара. В ситуации, если к товару не прикреплено изображение, сервер вернет ошибку с кодом 404 и изображение-заглушку

Остатки товаров в формате JSON

Данные возвращаются в кодировке UTF8.
Для получения данных, нужно отправить GET запрос на адрес:

https://slavyanochka-rukodelnica.ru/api/stock/API_KEY.json

Результат успешного запроса - JSON представление списка данных:

{
  "created": int,
  "items":
    [
      {
        "id": int,
        "sku": "string",
        "available": bool,
        "base_price": int,
        "user_price": int,
      },
      ...
    ]
}
Описание параметров:
Параметр Тип Значение
created int Время создания документа в формате Unixtimestamp. По этому параметру можно отслеживать изменения документа
items array Массив данных о товарах
items.id int ID товара
items.sku string Артикул товара (уникальный)
items.available bool Наличие товара
items.base_price int Базовая цена товара. Обычная цена, по которой мы осуществляем продажу. Цена указана в копейках
items.user_price int Ваша цена. Базовая цена товара с учетом вашей скидки на этот товар. Если у вас нет скидки на этот товар, то цена будет равна base_price. Цена указана в копейках

Список товаров в формате CSV

Формат адаптирован для работы в MS Excel.
Данные возвращаются в кодировке CP1251, разделитель полей ; (точка с запятой).
Для получения данных, нужно отправить GET запрос на адрес:

https://slavyanochka-rukodelnica.ru/api/products/API_KEY.csv

При запросе из браузера, будет вызван диалог скачивания файла.
В первой строке указаны названия колонок.
Результат успешного запроса - CSV представление списка товаров:

id;sku;name;price;size;brand;category1;category2;category3;image
Описание параметров:
Параметр Тип Значение
id int ID товара
sku string Артикул товара (уникальный)
name string Наименование товара
price int Базовая цена товара. Обычная цена, по которой мы осуществляем продажу. Цена указана в копейках
size string Размер товара в произвольном формате. Указывается не для всех типов товаров
brand sting Наименование производителя
category1 string Наименование категории 1 уровня
category2 string Наименование категории 2 уровня
category3 string Наименование категории 3 уровня
image string URL адрес изображения товара. В ситуации, если к товару не прикреплено изображение, сервер вернет ошибку с кодом 404 и изображение-заглушку

Остатки в формате CSV

Формат адаптирован для работы в MS Excel.
Данные возвращаются в кодировке CP1251, разделитель полей ; (точка с запятой).
Для получения данных, нужно отправить GET запрос на адрес:

https://slavyanochka-rukodelnica.ru/api/stock/API_KEY.csv

При запросе из браузера, будет вызван диалог скачивания файла.
В первой строке указаны названия колонок.
Результат успешного запроса - CSV представление списка товаров:

id;sku;price;available;
Описание параметров:
Параметр Тип Значение
id int ID товара
sku string Артикул товара (уникальный)
price int Базовая цена товара. Обычная цена, по которой мы осуществляем продажу. Цена указана в копейках
available int Наличие товара. 1 - в наличии, 0 - нет в наличии

Коды ошибок

В случае возникновения ошибки, система ответит одним из перечисленных HTTP кодов:
Код ошибки Значение
400 Не верный запрос. Запрос содержит не все необходимые данные
401 Указанный API_KEY не существует или заблокирован
404 Не найдено. Запрос отправлен на не существующий адрес
406 Не определены категории для экспорта
500 При обработке запроса возникла непредвиденная ошибка