Описание API оптовика - товары
Формат данных XML.
Получение количества товаров
Формат обрщения к API:
https://gidrolock.msk.ru/apiopt/api/xml/product/?op=count&key=ключПолучение количества товаров, доступных для получения информации через API.
Для получения количества товаров необходимо использовать GET параметр op:
- op - операция получения остатков, устанавливается значение count
<response>
<productsCount>9999</productsCount>
</response>
Описание формата результата:
| Элемент/Атрибут | Описание |
|---|---|
| Узел: productsCount | |
| текст | количество товаров, доступных для загрузки |
Получение остатков и цен
Формат обрщения к API:
https://gidrolock.msk.ru/apiopt/api/xml/product/?op=stock&key=ключ&offset=смещение&limit=количествоПолучение остатков и цен товаров без контента, передаваемых через API.
В целях обеспечения производительности, внесено ограничение на полуение списка товаров в размере 50 позиций. Для получения товаров необходимо использовать GET параметры op, offset и limit:
- op - операция получения остатков, устанавливается значение stock
- offset - позиция с которой нужно получать данные, нумерация начинается с 0. Если параметр не указан, то значение принимается за 0.
- limit - максимальное количество позиций передаваемых в выборке, максимальное значение 50. Если параметр не указан, то значение принимается за 50.
<response>
<offset>0</offset>
<limit>5</limit>
<prices>
<price>Цена сайта</price>
<price>Оптовая цена</price>
</prices>
<stock>
<product id="8" sku_id="8" category_id="25">
<name>Товар 1</name>
<sku>Артикул</sku>
<brand>Бренд</brand>
<prices>
<price tpype="retail" keep_price="1">
<name>Цена сайта</name>>
<value>1000.0000</value>
</feature<
<feature type="purchase">
<name>Оптовая цена</name>
<value>500.0000</value>
</feature>
</prices>
<count>100</count>
</product>
</stock>
</response>
Описание формата результата:
| Элемент/Атрибут | Описание |
|---|---|
| Узел: offset | |
| текст | Текущее смещение в выборке товаров |
| Узел: limit | |
| текст | Текущее количество товаров для выборки |
| Узел: prices | |
| Узел: prices/price | |
| текст | Наименование цены. |
| Узел: stock | |
| Узел: stock/product | |
| id | Идентификатор товара |
| sku_id | Идентификатор варианта товара. |
| category_id | Идентификатор категории. |
| name | Наименование товара. |
| sku | Артикул. |
| brand | Наименование бренда. |
| count | Количество товара. Может принимать числовое значение или "∞", если не указано конкретное значение количества товара, но товар есть. |
| Узел: stock/product/prices | |
| Узел: stock/product/prices/price | |
| type | Тип цены: retail - рекомендованая розничная цена; purchase - закупочная цена. |
| keep_price | Признак удержания цены не ниже рекомендованой розничной цены: 1 - удерживать цену; 0 - цена не контролируется. |
| name | Наименование цены. |
| value | Значение цены. |
| currency | Валюта цены. |
Получение контента
Формат обрщения к API:
https://gidrolock.msk.ru/apiopt/api/xml/product/?op=content&key=ключ&offset=смещение&limit=количествоПолучение контента товаров (наименование, описание, характеристики, изображения) без цен и остатков, передаваемого через API.
В целях обеспечения производительности, внесено ограничение на полуение списка товаров в размере 50 позиций. Для получения товаров необходимо использовать GET параметры op, offset и limit:
- op - операция получения остатков, устанавливается значение content
- offset - позиция с которой нужно получать данные, нумерация начинается с 0. Если параметр не указан, то значение принимается за 0.
- limit - максимальное количество позиций передаваемых в выборке, максимальное значение 50. Если параметр не указан, то значение принимается за 50.
<response>
<offset>0</offset>
<limit>5</limit>
<content>
<product id="8" sku_id="8" category_id="25">
<name>Товар 1</name>
<description>Описание товара 1</description>
<description_short>Описание товара 1</description_short>
<sku>Артикул</sku>
<brand>Бренд</brand>
<images>
<image filename="50937.original.jpeg">
http://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50937&key=123123123
</image>
<image filename="50938.original.jpeg">
http://domain.tld/shop/apiopt/api/xml/image/?op=image&id=50938&key=123123123
</image>
</images>
<features>
<feature status="public">
<name>Длина модели</name>>
<value>60 см</value>
</feature<
<feature status="public">
<name>Ширина модели</name>
<value>49 см</value>
</feature>
</features>
</product>
</content>
</response>
Описание формата результата:
| Элемент/Атрибут | Описание |
|---|---|
| Узел: offset | |
| текст | Текущее смещение в выборке товаров |
| Узел: limit | |
| текст | Текущее количество товаров для выборки |
| Узел: content | |
| Узел: content/product | |
| id | Идентификатор товара |
| sku_id | Идентификатор варианта товара. |
| category_id | Идентификатор категории. |
| name | Идентификатор категории. |
| description | Полное оприсание. |
| description_short | Краткое описание. |
| sku | Артикул товара. |
| brand | Наименование бренда. |
| Узел: content/product/images | |
| Узел: content/product/images/image | |
| filename | Оригинальное имя файла изображения, передаваемого по ссылке. |
| текст | Ссылка для скачивания изображения. Изоражение передается без водяных знаков, даже если на фронте выводится с надожением водяного знака. |
| Узел: content/product/features | |
| Узел: content/product/features/feature | |
| name | Наименование характеристики. |
| value | Значение характеристики. |