Все методы API


Формат данных JSON.

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

Формат обрщения к API:

https://custompaints.ru/apiopt/api/json/product/?op=count&key=ключ

Получение количества товаров, доступных для получения информации через API.

Для получения количества товаров необходимо использовать GET параметр op:

  • op - операция получения остатков, устанавливается значение count
{"product":{"productsCount":9999}}

Описание формата результата:

ЭлементОписание
Узел: productsCount
значениеколичество товаров, доступных для загрузки


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

Формат обрщения к API:

https://custompaints.ru/apiopt/api/json/product/?op=stock&key=ключ&offset=смещение&limit=количество

Получение остатков и цен товаров без контента, передаваемых через API.

В целях обеспечения производительности, внесено ограничение на полуение списка товаров в размере 50 позиций. Для получения товаров необходимо использовать GET параметры op, offset и limit:

  • op - операция получения остатков, устанавливается значение stock
  • offset - позиция с которой нужно получать данные, нумерация начинается с 0. Если параметр не указан, то значение принимается за 0.
  • limit - максимальное количество позиций передаваемых в выборке, максимальное значение 50. Если параметр не указан, то значение принимается за 50.
{
    "offset":"0",
    "limit":"50",
    "prices":[
        {"id":"0","name":"Цена сайта"},
        {"id":"3","name":"Оптовая цена"},
    ],
    "stock":[
        {
            "id":"8",
            "sku_id":"8",
            "category_id":"25",
            "name":"Товар 1",
            "sku":"Артикул",
            "brand":"Бренд",
            "prices":[
                {
                    "id":"0",
                    "type":"retail",
                    "name":"Цена сайта",
                    "currency":"RUB",
                    "price":"1000.0000",
                },
                {
                    "id":"3",
                    "type":"purchase",
                    "name":"Оптовая цена",
                    "currency":"RUB",
                    "price":"500.0000",
                }
            ],
            "count":"100",
        }
    ]
}

Описание формата результата:

ЭлементОписание
offsetТекущее смещение в выборке товаров
limitТекущее количество товаров для выборки
Элемент: prices
idИдентификатор цены.
nameНаименование цены.
Элемент: stock
idИдентификатор товара
sku_idИдентификатор варианта товара.
category_idИдентификатор категории.
nameНаименование товара.
skuАртикул.
brandНаименование бренда.
countКоличество товара. Может принимать числовое значение или "∞", если не указано конкретное значение количества товара, но товар есть.
Элемент: stock/prices
idИдентификатор цены.
typeТип цены: retail - рекомендованая розничная цена; purchase - закупочная цена.
keep_priceПризнак удержания цены не ниже рекомендованой розничной цены: 1 - удерживать цену; 0 - цена не контролируется.
nameНаименование цены.
priceЗначение цены.
currencyВалюта цены.


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

Формат обрщения к API:

https://custompaints.ru/apiopt/api/json/product/?op=content&key=ключ&offset=смещение&limit=количество

Получение контента товаров (наименование, описание, характеристики, изображения) без цен и остатков, передаваемого через API.

В целях обеспечения производительности, внесено ограничение на полуение списка товаров в размере 50 позиций. Для получения товаров необходимо использовать GET параметры op, offset и limit:

  • op - операция получения остатков, устанавливается значение content
  • offset - позиция с которой нужно получать данные, нумерация начинается с 0. Если параметр не указан, то значение принимается за 0.
  • limit - максимальное количество позиций передаваемых в выборке, максимальное значение 50. Если параметр не указан, то значение принимается за 50.
{
    "offset":"0",
    "limit":"50",
    "prices":[
        {"id":"0","name":"Цена сайта"},
        {"id":"3","name":"Оптовая цена"},
    ],
    "content":[
        {
            "id":"8",
            "sku_id":"8",
            "category_id":"25",
            "name":"Товар 1",
            "description":"Описание товара 1",
            "description_short":"Описание товара 1",
            "sku":"Артикул",
            "brand":"Бренд",
            "images":[
                {
                    "filename":"50937.original.jpeg",
                    "url":"http://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50937&key=123123123",
                },
                {
                    "filename":"50938.original.jpeg",
                    "url":"http://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50938&key=123123123",
                }
            ],
            "features":[
                {
                    "status":"public",
                    "name":"Длина модели",
                    "value":"60 см",
                },
                {
                    "status":"public",
                    "name":"Ширина модели",
                    "value":"49 см",
                }
            ],
        }
    ]
}

Описание формата результата:

ЭлементОписание
offsetТекущее смещение в выборке товаров
limitТекущее количество товаров для выборки
Элемент: content
idИдентификатор товара
sku_idИдентификатор варианта товара.
category_idИдентификатор категории.
nameИдентификатор категории.
descriptionПолное оприсание.
description_shortКраткое описание.
skuАртикул товара.
brandНаименование бренда.
Элемент: content/images
filenameОригинальное имя файла изображения, передаваемого по ссылке.
urlСсылка для скачивания изображения. Изоражение передается без водяных знаков, даже если на фронте выводится с надожением водяного знака.
Элемент: content/features
nameНаименование характеристики.
valueЗначение характеристики.