You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 40 Next »

Формат ответа

Формат ответа регулируется заголовком Accept.

Например: Accept: application/json.

application/json

Для получения данных в формате json необходимо указать в заголовке Accept значение application/json.

Поля ответа

НаименованиеТипОписание
dataarrayРезультат выполнения вызываемого метода.
messagesarray

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

Например ограничение возвращаемых данных с определенных складов по причине превышения количества разрешенных запросов.

timefloatВремя обработки запроса.

Сообщения

Формат сообщений

Наименование поляТипОписание
levelstring

Уровень сообщения.

codeintegerУникальный код для типа сообщения.
textstringТекст сообщения.

Уровни сообщений

  1. info — Какая-либо информация не влияющая на работоспособность API.
  2. warning — Предупреждение свидетельствующее о каких-либо ограничениях о проблемах связанных со взаимодействием с API в будущем (например: приближение к максимальному количеству запросов, запланированные технические работы, низкая сумма на балансе).
  3. critical — Важное предупреждение связанное с какими-либо ограничениями во взаимодействии с API (например ограничение выдачи по причине превышения максимального количества запросов).

Типы сообщений

КодУровеньСообщение
100warningПриближение количества запросов к максимальному.
200criticalДостигнуто максимальное количество запросов.

Состояния товара

НаименованиеОписание
newНовый товар.
used

Товар бывший в употреблении.

Как правило в attributes.wear указывается процент износа.

Атрибуты товаров

НаименованиеТипОписание
wearintПроцент износа товара бывшего в употреблении.

Методы

Получение токена для авторизации

POST /auth

Параметры

НаименованиеТипОбязателенОписание
loginstringдаЛогин для входа в API.
passwordstringдаПароль для входа в API.

Формат ответа

Наименование поляТипОписание
tokenstringТокен для авторизации через Bearer Token.
expiresintegerВремя (unixtime) окончания срока действия токена.

Поиск артикулов производителей

GET /manufacturer/articles

НаименованиеТипОбязателенОписание
articlestringдаАртикул производителя.
manufacturer_namestringнет

Наименование производителя.

Поддерживаются wildcards (например *knecht) при условии, что задан хотя бы один символ наименования (за исключением *).

Формат ответа

Ответ возвращается в виде массива найденных артикулов.

Наименование поляТипОписание
articlestring Артикул производителя.
manufacturerobjectПроизводитель товара.
manufacturer.idstringИдентификатор производителя товара.
manufacturer.namestringНаименование производителя товара.
manufacturer.countryobjectСтрана произовдителя товара.
manufacturer.country.idstringИдентификатор страны.
manufacturer.country.namestringНаименование страны.
nameobjectНаименование.
name.idstringИдентификатор наименования.
name.namestringНаименование.
attributesobjectРазличные атрибуты, например: размер, вес.

Получение товаров в наличии по артикулу производителя

GET /offers/manufacturer/{manufacturer_id}/{condition}

Параметры в URL

НаименованиеОписание
manufacturer_idИдентификатор компании-производителя.
condition

Состояние товара.

Возможные значения:

  • new — новые товары;
  • used — товары бывшие в употреблении.

Параметры

НаименованиеТипОбязателенОписание
articlestringдаАртикул производителя.
replacementsbooleanнетВозвращать ли товары-аналоги.
limitintegerнет

Ограничение возвращенных строк из массива offers.

По умолчанию 30.

offsetintegerнет

Возвращать строки из массива offers начиная с указанной позиции.

По умолчанию 0.

Формат ответа

Наименование поляТипОписание
manufacturer_articlesarray

Список найденный артикулов производителей.

Возвращаются в виде ключ-значение, ключом является уникальный идентификатор, по которому можно сопоставить элементы данного справочника с соответствующим полем в offers.

manufacturer_articles[].articlestringАртикул производителя.
manufacturer_articles[].manufacturerobjectОписание компании-производителя.
manufacturer_articles[].manufacturer.idstringИдентификатор компании-производителя.
manufacturer_articles[].manufacturer.namestringНаименование компании-производителя.
imageobject

Фото товара для предпросмотра.

В этом поле возвращается только одна фото, полный список можно получить методом получения полной информации о товаре.

TODO: Ссылка на метод.

image.urlstringСсылки на фото миниатюр.
image.thumbnailsarrayСсылки на фото миниатюр.
skusarrayАртикулы поставщика.
skus[].nameobjectНаименование товара.
skus[].name.idstringИдентификатор наименования товара.
skus[].name.namestringНаименование товара.
skus[].conditionstringСостояние товара.
skus[].commentstringКомментарий поставщика.
skus[].attributesobjectАтрибуты товара.
skus[].imageobject

Фото товара для предпросмотра.

В этом поле возвращается только одна фото, полный список можно получить методом получения полной информации о товаре.

TODO: Ссылка на метод.

skus[].image.urlstringСсылка на фото большого размера.
skus[].image.thumbnailsarrayСсылки на фото миниатюр.
offersarrayСписок предложений.
offers[].manufacturer_article_idstringАртикул произовдителя.
offer[].skustringАртикул поставщика.
offers[].quantityintegerКоличество товара доступное для заказа.
offers[].pricefloatЦена.
offers[].store_idstringИдентификатор точки выдачи.
offers[].labelsobject

Метки присвоенные предложению поставщиком.

Здесь могут возвращаться например:

  • название акции на товар;
  • особенности заказа товара (оплата только за наличный расчет).
storesarray

Список точек выдачи.

Ключом является идентификатор точки выдачи.

stores[].addressstringАдрес точки выдачи.

Информация о товаре по артикулу поставщика

GET /supplier/article

Параметры

НаименованиеТипПараметры
articlestringАртикул поставщика.

Формат ответа

Наименование поляТипОписание









  • No labels