Методы для работы с API

Лимит запросов к API

На каждое приложение накладываются персональное ограничение (обычно в 500 запросов к API за 5 минут). Время рассчитывается с момента первого запроса в серии.

Количество выполненных запросов в текущей серии передается в каждом ответе API в HTTP заголовке API-Usage-Limit (пример: API-Usage-Limit: 1/500).

При превышении лимита доступ к API становится недоступным до окончания текущих 5 минут. В таком случае код ответа сервера - 429 и при этом в HTTP заголовке Retry-After передается время до начала предоставления доступа в секундах.

Универсальные параметры запросов

Параметр Обязательный Значение по умолчанию Описание
apikey да

Параметр, необходимый для авторизации и совершения запросов API. Предоставляется системой.

format нет "json"

Формат вывода ответа. Возможные значения: "json", "xml"

HTTP ETag (Контроль версий)

Заголовок "Entity Tag" (или коротко ETag) используется для передачи хэша содержания страницы. Если страница была изменена, то хэш страницы тоже изменится. Сравнивая хэш на стороне клиента с хэшем, генерируемым на стороне сервера, кэш может определить, была ли станица изменена и требуется ли её передавать заново. Используется для таких методов: product, categories, brands.

При запросе, сервер возвращает ресурс вместе с соответствующим значением ETag, который находится в HTTP заголовке в поле ETag:
ETag: "686897696a7c876b7e"
Затем можно кэшировать ресурс вместе с его ETag. Позже, при получении страницы с того же адреса, можно послать ранее сохраненное значение ETag вместе с запросом в поле If-None-Match.
If-None-Match: "686897696a7c876b7e"

На этот запрос сервер сравнит ETag клиента с ETag для текущей версии ресурса. Если значения ETag совпадают, это означает, что ресурс не изменился, сервер отправит обратно очень короткий ответ с HTTP статусом 304 Not Modified. Статус 304 сообщает, что кэш версия по-прежнему актуальна и обновление данных не требуется.
Однако, если ETag-значения не совпадают, значит ресурс изменился и сервер вернет полный ответ. В этом случае можно обновить кэш ресурса и его ETag.

При использовании Etag и получении ответа со статусом 304 Not Modified лимит использования API не действует.

Для метода product длина хеша ETag зависит от количества товаров в ответе. Максимальная длина - 4Kb.

Пример заголовка с ETag:


Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
                        

Пример ответа со статусом 304:


Content-type: application/json; charset=utf-8
Status Code: 304
                        

Коды ответов

  • 200 — OK
  • 304 — Страница не изменилась
  • 400 — Ошибка в параметрах запроса
  • 401 — Не авторизован, в запросе отсутствует apikey
  • 403 — Нет доступа к запрашиваемой информации
  • 404 — Запрашиваемая информация не найдена
  • 429 — Превышен лимит запросов к API, в HTTP заголовке Retry-After передается время до начала предоставления доступа в секундах
  • 500 — Внутренняя ошибка сервера
  • 501 — Метод не существует
  • 503 — Сервис недоступен, техническое обслуживание, повторите запрос позже

PHP API client

Для интеграции с Listex API можно использовать специальный клиент на PHP. Он доступен в GitHub репозитории listex_php_api. Там же описан пример его инициализации и использования.

Метод attributes

Возвращает список атрибутов как публичных так и приватных для запрашивающего аккаунта.

Пример запроса

https://api.listex.info/v3/attributes?apikey=XXX&cat_id=2&attr_type=m

Параметры запроса

  • cat_id — (необязательный) идентификатор категории, к которой относятся атрибуты. Если не указан, возвращается полный список атрибутов доступных для запрашивающего аккаунта.
  • attr_type — (необязательный) возможные значения параметра
    • a — (используется по-умолчанию) вернуть все атрибуты
    • m — вернуть только обязательные атрибуты
    • r — вернуть только рекомендуемые атрибуты
    • o — вернуть только опциональные атрибуты

Параметры ответа

  • attr_id - идентификатор атрибута
  • attr_name - наименование атрибута
  • attr_group_name - наименование группы, к которой относится атрибут
  • attr_group_id - идентификатор группы, к которой относится атрибут
  • attr_preset - массив возможных значений атрибута
  • attr_type - тип атрибута, будет указано, только при наличии cat_id в запросе

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
  "apiversion": 3,
  "result": [
    {
      "attr_id": 1,
      "attr_name": "Содержание смолы",
      "attr_group_name": "Прочее",
      "attr_group_id": 26
    },
    {
      "attr_id": 42,
      "attr_name": "Вкус",
      "attr_group_name": "Основные качества",
      "attr_group_id": 11,
      "attr_preset": [ "Абрикос", "Малина", "Яблоко" ],
      "attr_type": "m"
    }
    ...
  ]
}

XML


Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <apiversion>3</apiversion>
    <result>
        <item>
            <attr_id>1</attr_id>
            <attr_name>Содержание смолы</attr_name>
            <attr_group_name>Прочее</attr_group_name>
            <attr_group_id>26</attr_group_id>
            <attr_preset/>
        </item>
        <item>
            <attr_id>42</attr_id>
            <attr_name>Вкус</attr_name>
            <attr_group_name>Основные качества</attr_group_name>
            <attr_group_id>11</attr_group_id>
            <attr_preset>
                <value>Абрикос</value>
                <value>Малина</value>
                <value>Яблоко</value>
            </attr_preset>
            <attr_type>m</attr_type>
        </item>
    </result>
</root>

Метод brands

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

Пример запроса

https://api.listex.info/v3/brands?apikey=XXX

Параметры запроса

Отсутствуют.

Параметры ответа

  • brand_id - идентификатор бренда
  • brand_name - наименование бренда

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
  "apiversion": 3,
  "result": [
    {
      "brand_id": 8117,
      "brand_name": "1 Вересня"
    },
    {
      "brand_id": 6262,
      "brand_name": "Nike"
    },
    {
      "brand_id": 7105,
      "brand_name": "Roshen"
    },
    {
      "brand_id": 6035,
      "brand_name": "1000 секретов"
    }...
  ]
}

XML

Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <apiversion>3</apiversion>
    <result>
        <item>
            <brand_id>8117</brand_id>
            <brand_name>1 Вересня</brand_name>
        </item>
        <item>
            <brand_id>6262</brand_id>
            <brand_name>Nike</brand_name>
        </item>
        <item>
            <brand_id>7105</brand_id>
            <brand_name>Roshen</brand_name>
        </item>
        <item>
            <brand_id>6035</brand_id>
            <brand_name>1000 секретов</brand_name>
        </item>
        ...
    </result>
</root>

Метод categories

Используется для получения дерева категорий Listex, корень дерева не возвращается.

Пример запроса

https://api.listex.info/v3/categories?apikey=XXX

Параметры запроса

Отсутствуют.

Параметры ответа

  • cat_id - идентификатор категории
  • cat_name - наименование категории
  • cat_parent_id - идентификатор родительской категории
  • cat_level - уровень в дереве категорий (1 верхний уровень, 2 подлежащий и так далее)

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
  "apiversion": 3,
  "result": [
    {
      "cat_id": 14001,
      "cat_name": "Продукты питания",
      "cat_parent_id": 14000,
      "cat_level": "1"
    },
    {
      "cat_id": 14002,
      "cat_name": "Напитки",
      "cat_parent_id": 14001,
      "cat_level": 2
    }
    ...
  ]
}

XML

Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <apiversion>3</apiversion>
    <result>
        <item>
            <cat_id>14002</cat_id>
            <cat_name>Напитки</cat_name>
            <cat_parent_id>14000</cat_parent_id>
            <cat_level>2</cat_level>
        </item>
        <item>
            <cat_id>14001</cat_id>
            <cat_name>Питание</cat_name>
            <cat_parent_id>14000</cat_parent_id>
            <cat_level>2</cat_level>
        </item>
    </result>
</root>

Метод product

Метод возвращает краткую или полную информацию о продукте (товаре). Требует обязательного указания одного из следующих параметров: идентификатор товара, GTIN (штрих-код), LTIN или SKU с указанием идентификатора торговой сети, который относится к запрашиваемому аккаунту.

Если указаны более одного из обязательных параметров, то возвращается результат выборки, соответствующий данному алгоритму:

  • good_id - при указании, возвращается товар с соответствующим идентификатором или ошибка 404. При этом GTIN, LTIN и SKU игнорируются.
  • gtin - при указании, возвращается товар с соответствующим GTIN или ошибка 404. При этом LTIN и SKU игнорируются.
  • ltin - при указании, возвращается товар с соответствующим LTIN или ошибка 404. При этом SKU игнорируется.
  • sku - при указании, возвращается товар с соответствующим SKU или ошибка 404.

Пример запроса

https://api.listex.info/v3/product?apikey=XXX&gtin=6411300162475

Параметры запроса

  • good_id — идентификатор товара в каталоге Listex (обязательный, если отсутствуют gtin, ltin, sku)
  • gtin — глобальный штрих-код GTIN (обязательный, если отсутствуют good_id, ltin, sku)
  • ltin — локальный штрих-код LTIN (например весовые шк) (обязательный, если отсутствуют good_id, gtin, sku)
  • sku — локальный идентификатор товарной позиции (артикул) (обязательный, если отсутствуют good_id, gtin, ltin)
  • party_id — идентификатор торговой сети (обязательный, если при запросе указан ltin и sku)

Параметры ответа

  • identified_by — массив содержащий информацию о штрих-кодах (ltin/sku отдаются только те, которые принадлежат party для аккаунта apikey)
    • value — штрих-код или локальный идентификатор
    • type — тип штрих-кода
      • gtin — глобальный штрих-код GTIN
      • ltin — локальный штрих-код LTIN (например весовые шк)
      • sku — локальный идентификатор товарной позиции (артикул)
    • party_id — идентификатор торговой сети, возвращается только при условии, что параметр type имеет значение ltin или sku.
    • multiplier — количество товаров в упаковке, по-умолчанию 1
  • good_id — идентификатор товара
  • good_name — наименование товара
  • good_img — изображение товара
  • categories — массив категорий
    • cat_id — идентификатор категории, в которой расположен товар, исключая парентов этой категории.
    • cat_name — наименование категории, в которой расположен товар
  • brand_id — идентификатор бренда товара
  • brand_name — наименование бренда
  • good_rating — рейтинг товара
  • good_avg_price — цена товара
  • good_avg_price_currency — наименование валюты (по стандарту ISO 4217)
  • good_images — массив с изображениями
    • photo_type — тип фотографии
      • default — фотография по умолчанию (вид спереди)
      • facing — crop-фотография для планограмм (обрезанная по контуру товара)
      • left — фотография товара слева
      • right — фотография товара справа
      • back — фотография товара сзади
      • 3ds — 3D серия
      • undef — single shot, фотография товара с не предопределенного ракурса
    • photo_url — ссылка на med (medium) размер фотографии
  • good_attrs — массив с атрибутами (приватные атрибуты отдаются только те, которые принадлежат аккаунту apikey)
    • attr_name — наименование атрибута
    • attr_value — значение атрибута
    • attr_value_type — тип значения атрибута
    • attr_group_id — идентификатор группы атрибутов
    • attr_group_name — наименование группы атрибутов
  • good_reviews — массив с отзывами
    • review_id — идентификатор отзыва
    • review_author — автор (имя, фамилия, псевдоним)
    • review_rating — рейтинг отзыва
    • review_text — текст отзыва
    • review_date — дата создания отзыва в UTC
    • review_author_img — ссылка на фотографию автора
    • review_replies — массив отзывов. Возвращается, если отзыв имеет ответы (т.е. отзывы со значением review_parent_id равным идентификатору данного/родительского отзыва)
      • review_id — идентификатор отзыва-ответа
      • review_author — автор (имя, фамилия, псевдоним)
      • review_rating — рейтинг отзыва-ответа
      • review_text — текст отзыва-ответа
      • review_date — дата создания отзыва в UTC
      • review_author_img — ссылка на фотографию автора
  • good_reviews_count — количество отзывов
  • good_prices — массив цен на товар по торговым сетям данного аккаунта:
    • good_price — цена на товар (если не установлена или 0.00, то выводим пустую строку)
    • good_price_currency — наименование валюты (ISO 4217)
    • party_id — идентификатор торговой сети
    • address— местонахождение
      • country — название страны (ISO 3166-2)
      • city — название города
      • street — название улицы, дом
      • location — координаты
        • lat — географическая широта
        • lon — географическая долгота

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
{
  "apiversion": 3,
  "result": [
    {
      "good_id": 672136,
      "identified_by": [],
      "good_name": "Gala пральний порошок авт. 1,5кг. Свіжість гірської лаванди",
      "good_url": "https://listex.info/product/gala-pralniy-poroshok-avt-15kg-svizhist-girskoi-lavandi",
      "good_img": "https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg",
      "categories": [
        {
          "cat_id": 14786,
          "cat_name": "Порошки"
        }
      ],
      "brand_id": null,
      "brand_name": null,
      "good_rating": 4.33333,
      "good_avg_price": null,
      "good_avg_price_currency": null,
      "good_images": [
        {
          "photo_type": "default",
          "photo_url": "https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg"
        },
        {
          "photo_type": "3ds",
          "photo_url": [
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.0.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.1.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.2.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.3.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.4.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.5.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.6.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.7.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.8.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.9.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.10.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.11.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.12.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.13.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.14.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.15.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.16.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.17.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.18.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.19.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.20.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.21.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.22.jpg",
            "https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.23.jpg"
          ]
        },
        {
          "photo_type": "left",
          "photo_url": "https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.6.jpg"
        },
        {
          "photo_type": "right",
          "photo_url": "https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.18.jpg"
        },
        {
          "photo_type": "back",
          "photo_url": "https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.12.jpg"
        }
      ],
      "good_attrs": [
        {
          "attr_name": "Вес брутто",
          "attr_value": "1.506",
          "attr_value_type": "кг",
          "attr_group_id": 19,
          "attr_group_name": "Cubiscan-атрибуты"
        },
        {
          "attr_name": "Высота",
          "attr_value": "29.2",
          "attr_value_type": "см",
          "attr_group_id": 19,
          "attr_group_name": "Cubiscan-атрибуты"
        },
        {
          "attr_name": "Глубина",
          "attr_value": "",
          "attr_value_type": "см",
          "attr_group_id": 19,
          "attr_group_name": "Cubiscan-атрибуты"
        },
        {
          "attr_name": "Ширина",
          "attr_value": "20.7",
          "attr_value_type": "см",
          "attr_group_id": 19,
          "attr_group_name": "Cubiscan-атрибуты"
        }
      ],
      "good_reviews": [
        {
          "review_id": 286,
          "review_author": "TestUserReviewName",
          "review_rating": 4,
          "review_text": "Отлично!",
          "review_date": "2016-11-28T09:31:54+00:00",
          "review_author_img": "https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50",
          "review_replies": [
            {
              "review_id": 288,
              "review_author": "TestUserReviewReplyName",
              "review_rating": 4,
              "review_text": "Perfect!!!",
              "review_date": "2016-11-28T09:49:39+00:00",
              "review_author_img": "https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50"
            }
          ]
        },
        {
          "review_id": 282,
          "review_author": "Maria Moryakina",
          "review_rating": 5,
          "review_text": "Вкусно пахнет",
          "review_date": "2016-11-17T11:19:48+00:00",
          "review_author_img": "https://scontent.xx.fbcdn.net/v/t1.0-1/c0.17.100.100/p100x100/14102384_286143021757109_2710809744588865430_n.jpg?oh=2eb1e9f751c01e58c7b9fdc76dc7153b&oe=58F8B7F4"
        }
      ],
      "good_reviews_count": 3,
      "good_prices": []
    }
  ]
}

XML

Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Etag: "38fho43p543re634c993ec28581d867"
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <apiversion>3</apiversion>
    <result>
        <item>
            <good_id>672136</good_id>
            <identified_by/>
            <good_name>Gala пральний порошок авт. 1,5кг. Свіжість гірської лаванди</good_name>
            <good_url>https://listex.info/product/gala-pralniy-poroshok-avt-15kg-svizhist-girskoi-lavandi</good_url>
            <good_img>https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg</good_img>
            <categories>
                <item>
                    <cat_id>14786</cat_id>
                    <cat_name>Порошки</cat_name>
                </item>
            </categories>
            <brand_id></brand_id>
            <brand_name></brand_name>
            <good_rating>4,33333</good_rating>
            <good_avg_price></good_avg_price>
            <good_avg_price_currency></good_avg_price_currency>
            <good_images>
                <item>
                    <photo_type>default</photo_type>
                    <photo_url>https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.jpg</photo_url>
                </item>
                <item>
                    <photo_type>3ds</photo_type>
                    <photo_url>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.0.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.1.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.2.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.3.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.4.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.5.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.6.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.7.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.8.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.9.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.10.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.11.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.12.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.13.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.14.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.15.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.16.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.17.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.18.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.19.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.20.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.21.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.22.jpg</item>
                        <item>https://icf.listex.info/med/3d/63d3beae-b0be-db33-f86b-65a0e37da584.3d.23.jpg</item>
                    </photo_url>
                </item>
                <item>
                    <photo_type>left</photo_type>
                    <photo_url>https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.6.jpg</photo_url>
                </item>
                <item>
                    <photo_type>right</photo_type>
                    <photo_url>https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.18.jpg</photo_url>
                </item>
                <item>
                    <photo_type>back</photo_type>
                    <photo_url>https://icf.listex.info/med/63d3beae-b0be-db33-f86b-65a0e37da584.12.jpg</photo_url>
                </item>
            </good_images>
            <good_attrs>
                <item>
                    <attr_name>Вес брутто</attr_name>
                    <attr_value>1.506</attr_value>
                    <attr_value_type>кг</attr_value_type>
                    <attr_group_id>19</attr_group_id>
                    <attr_group_name>Cubiscan-атрибуты</attr_group_name>
                </item>
                <item>
                    <attr_name>Высота</attr_name>
                    <attr_value>29.2</attr_value>
                    <attr_value_type>см</attr_value_type>
                    <attr_group_id>19</attr_group_id>
                    <attr_group_name>Cubiscan-атрибуты</attr_group_name>
                </item>
                <item>
                    <attr_name>Глубина</attr_name>
                    <attr_value></attr_value>
                    <attr_value_type>см</attr_value_type>
                    <attr_group_id>19</attr_group_id>
                    <attr_group_name>Cubiscan-атрибуты</attr_group_name>
                </item>
                <item>
                    <attr_name>Ширина</attr_name>
                    <attr_value>20.7</attr_value>
                    <attr_value_type>см</attr_value_type>
                    <attr_group_id>19</attr_group_id>
                    <attr_group_name>Cubiscan-атрибуты</attr_group_name>
                </item>
            </good_attrs>
            <good_reviews>
                <item>
                    <review_id>286</review_id>
                    <review_author>TestUserReviewName</review_author>
                    <review_rating>4</review_rating>
                    <review_text>Отлично!</review_text>
                    <review_date>2016-11-28T09:31:54+00:00</review_date>
                    <review_author_img>https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
                    <review_replies>
                        <item>
                            <review_id>288</review_id>
                            <review_author>TestUserReviewReplyName</review_author>
                            <review_rating>4</review_rating>
                            <review_text>Perfect!!!</review_text>
                            <review_date>2016-11-28T09:49:39+00:00</review_date>
                            <review_author_img>https://lh5.googleusercontent.com/-F0rhYj_uC6o/AAAAAAAAAAI/AAAAAAAAFUs/_nuL7XLXK88/photo.jpg?sz=50</review_author_img>
                        </item>
                    </review_replies>
                </item>
                <item>
                    <review_id>282</review_id>
                    <review_author>Maria Moryakina</review_author>
                    <review_rating>5</review_rating>
                    <review_text>Вкусно пахнет</review_text>
                    <review_date>2016-11-17T11:19:48+00:00</review_date>
                    <review_author_img>https://scontent.xx.fbcdn.net/v/t1.0-1/c0.17.100.100/p100x100/14102384_286143021757109_2710809744588865430_n.jpg?oh=2eb1e9f751c01e58c7b9fdc76dc7153b&amp;oe=58F8B7F4</review_author_img>
                </item>
            </good_reviews>
            <good_reviews_count>3</good_reviews_count>
            <good_prices/>
        </item>
    </result>
</root>

Метод suggestions

Возвращает список товаров по найденному соответствию в имени.

Пример запроса

https://api.listex.info/v3/suggestions?apikey=XXX&q=Мыл

Параметры запроса

  • q — (обязательный) строка для поиска по наименованию товара

Параметры ответа

  • good_name — наименование товара
  • good_id — идентификатор товара
  • brand_name — наименование бренда
  • good_img — фотография товара по умолчанию (размер 300x200px)

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
  "apiversion": 3,
  "result": [
    {
      "good_name": "Мыло туалетное Ягоды калиновые Родное мыло",
      "good_id": "319932",
      "brand_name": "Шик",
      "good_img": "https://icf.listex.info/e6104f.jpg"
    },
    {
      "good_name": "Мыло туалетное Душисты Родное мыло Шик 80г",
      "good_id": "319933",
      "brand_name": "Шик",
      "good_img": "https://icf.listex.info/aabac1c6.jpg"
    }
    ...
  ]
}

XML

Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <apiversion>3</apiversion>
  <result>
    <item>
      <good_id>319932</good_id>
      <good_name>Мыло туалетное Ягоды калиновые Родное мыло Шик 80г</good_name>
      <brand_name>Шик</brand_name>
      <good_img>https://icf.listex.info/e6104f.jpg</good_img>
    </item>
    <item>
      <good_id>319933</good_id>
      <good_name>Мыло туалетное Душистые бархатцы Родное мыло Шик 80г</good_name>
      <brand_name>Шик</brand_name>
      <good_img>https://icf.listex.info/aabac1c6.jpg</good_img>
    </item>
    ...
  </result>
</root>

Метод addreview

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

Пример запроса

https://api.listex.info/v3/addreview?apikey=XXX&review_parent_id=174
или
https://api.listex.info/v3/addreview?apikey=XXX&good_id=62433

POST-параметр Значение параметра
review_text "Отличное средство!"
social_type "gp"
social_id "120076146314"
review_author "Petrenko Petro"
review_rating 4

Параметры запроса

GET-параметры:

  • review_parent_id — идентификатор родительского отзыва (при указании родительского идентификатора, указывать идентификатор сущности не требуется, т.к. он игнорируется)
  • brand_id — идентификатор бренда (необходимо указать, если не задан review_parent, party_id, good_id)
  • party_id — идентификатор торговой сети (необходимо указать, если не задан review_parent, brand_id, good_id)
  • good_id — идентификатор товара (необходимо указать, если не задан review_parent, party_id, brand_id)

POST-параметры:

  • review_text — (обязательный) текст отзыва
  • social_type — (обязательный) тип используемого сервиса для авторизации, возможные значения:
    • gp — Google plus
    • fb — Facebook
    • tw — Twitter
    • vk — VK
  • social_id — (обязательный) идентификатор пользователя для сервиса авторизации, указанного в social_type.
  • review_author — (обязательный) автор (имя, фамилия, псевдоним)
  • review_rating — (обязательный) рейтинг, выставленный автором отзыва (число от 0 до 5)

Параметры ответа

  • review_id — идентификатор отзыва.
  • review_parent_id — идентификатор родительского отзыва, если это ответ.
  • brand_id — идентификатор бренда, если отзыв относится к этой сущности.
  • good_id — идентификатор товара, если отзыв относится к этой сущности.
  • party_id — идентификатор торговой сети, если отзыв относится к этой сущности.
  • review_rating — рейтинг, выставленный автором (число от 0 до 5)
  • review_text — текст отзыва
  • review_date — дата создания отзыва в UTC
  • review_author — автор (имя, фамилия, псевдоним)
  • review_author_img — ссылка на фотографию автора

JSON

Content-type: application/json; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
{
  "apiversion": 3,
  "result": {
    "review_id": 181,
    "good_id": 62084,
    "review_author": "Petrenko Petro",
    "review_rating": 4,
    "review_text": "Отличное средство!",
    "review_date": "2016-10-21 10:17:13",
    "review_author_img": "https://plus.google.com/petro.jpg"
  }
}

XML

Content-type: application/xml; charset=utf-8
API-Usage-Limit: 1/500
Status Code: 200
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <apiversion>3</apiversion>
  <result>
    <review_id>181</review_id>
    <good_id>62084</good_id>
    <review_author>Petrenko Petro</review_author>
    <review_rating>4</review_rating>
    <review_text>Отличное средство!</review_text>
    <review_date>2016-10-21 10:17:13</review_date>
    <review_author_img>https://plus.googl.jpg</review_author_img>
  </result>
</root>

Метод image

Дает возможность пропорционально изменить размер изображения с заполнением не достающих полей белым цветом. Метод принимает и фозвращает формат JPEG.

Пример запроса

https://api.listex.info/v3/image?apikey=XXX&name=https://icf.listex.info/300x200/5a7eb614-13d3-69ed-caf7-420624d1bdd3.jpg&width=300&height=400

Параметры запроса

GET-параметры:

  • name — полный URI изображения, те что приходят в ответе API
  • width — ширина рисунка на выходе, должна быть в границах [100, 1000] (результирующая высота в пикселях)
  • height — высота рисунка на выходе, должна быть в границах [100, 1000] (результирующая ширина в пикселях)

Ответ

Ответом метода является фото уже измененного размера.