Формат ответа
Формат ответа регулируется заголовком Accept.
Например: Accept: application/json.
application/json
Для получения данных в формате json необходимо указать в заголовке Accept значение application/json.
Поля ответа
Наименование | Тип | Описание |
---|---|---|
data | array | Результат выполнения вызываемого метода. |
messages | array | Список сообщений, который может содержать сообщения об ограничениях в возвращаемых данных. Например ограничение возвращаемых данных с определенных складов по причине превышения количества разрешенных запросов. |
time | float | Время обработки запроса. |
Сообщения
Формат сообщений
Наименование поля | Тип | Описание |
---|---|---|
level | string | Уровень сообщения. |
code | integer | Уникальный код для типа сообщения. |
text | string | Текст сообщения. |
Уровни сообщений
- info — Какая-либо информация не влияющая на работоспособность API.
- warning — Предупреждение свидетельствующее о каких-либо ограничениях о проблемах связанных со взаимодействием с API в будущем (например: приближение к максимальному количеству запросов, запланированные технические работы, низкая сумма на балансе).
- critical — Важное предупреждение связанное с какими-либо ограничениями во взаимодействии с API (например ограничение выдачи по причине превышения максимального количества запросов).
Максимальное количество разрешенных запросов
Код | Уровень | Сообщение |
---|---|---|
100 | warning | Приближение количества запросов к максимальному. |
200 | critical | Достигнуто максимальное количество запросов. |
Состояния товара
Наименование | Описание |
---|---|
new | Новый товар. |
used | Товар бывший в употреблении. Как правило в attributes.wear указывается процент износа. |
Атрибуты товаров
Наименование | Тип | Описание |
---|---|---|
wear | int | Процент износа товара бывшего в употреблении. |
Методы
Получение токена для авторизации
POST /auth
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
login | string | да | Логин для входа в API. |
password | string | да | Пароль для входа в API. |
Формат ответа
Наименование поля | Тип | Описание |
---|---|---|
token | string | Токен для авторизации через Bearer Token. |
expires | integer | Время (unixtime) окончания срока действия токена. |
Поиск артикулов производителей
GET /article
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
article | string | да | Артикул производителя. |
manufacturer_name | string | нет | Наименование производителя. Поддерживаются wildcards (например *knecht) при условии, что задан хотя бы один символ наименования (за исключением *). |
Формат ответа
Ответ возвращается в виде массива найденных артикулов.
Наименование поля | Тип | Описание |
---|---|---|
article | string | Артикул производителя. |
manufacturer | object | Производитель товара. |
manufacturer.id | string | Идентификатор производителя товара. |
manufacturer.name | string | Наименование производителя товара. |
manufacturer.country | object | Страна произовдителя товара. |
manufacturer.country.id | string | Идентификатор страны. |
manufacturer.country.name | string | Наименование страны. |
name | object | Наименование. |
name.id | string | Идентификатор наименования. |
name.name | string | Наименование. |
attributes | object | Различные атрибуты, например: размер, вес. |
Получение товаров в наличии по артикулу производителя
GET /offers/manufacturer/{manufacturer_id}/{condition}
Параметры в URL
Наименование | Описание |
---|---|
manufacturer_id | Идентификатор компании-производителя. |
condition | Состояние товара. Возможные значения:
|
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
article | string | да | Артикул производителя. |
replacements | boolean | нет | Возвращать ли товары-аналоги. |
limit | integer | нет | Ограничение возвращенных строк из массива offers. По умолчанию 30. |
offset | integer | нет | Возвращать строки из массива offers начиная с указанной позиции. По умолчанию 0. |
Формат ответа
Наименование поля | Тип | Описание |
---|---|---|
manufacturer_articles | array | Список найденный артикулов производителей. Возвращаются в виде ключ-значение, ключом является уникальный идентификатор, по которому можно сопоставить элементы данного справочника с соответствующим полем в offers. |
manufacturer_articles[].article | string | Артикул производителя. |
manufacturer_articles[].manufacturer | object | Описание компании-производителя. |
manufacturer_articles[].manufacturer.id | string | Идентификатор компании-производителя. |
manufacturer_articles[].manufacturer.name | string | Наименование компании-производителя. |
image | object | Фото товара для предпросмотра. В этом поле возвращается только одна фото, полный список можно получить методом получения полной информации о товаре. TODO: Ссылка на метод. |
image.url | string | Ссылки на фото миниатюр. |
image.thumbnails | array | Ссылки на фото миниатюр. |
skus | array | Артикулы поставщика. |
skus[].name | object | Наименование товара. |
skus[].name.id | string | Идентификатор наименования товара. |
skus[].name.name | string | Наименование товара. |
skus[].condition | string | Состояние товара. |
skus[].comment | string | Комментарий поставщика. |
skus[].attributes | object | Атрибуты товара. |
skus[].image | object | Фото товара для предпросмотра. В этом поле возвращается только одна фото, полный список можно получить методом получения полной информации о товаре. TODO: Ссылка на метод. |
skus[].image.url | string | Ссылка на фото большого размера. |
skus[].image.thumbnails | array | Ссылки на фото миниатюр. |
offers | array | Список предложений. |
offers[].manufacturer_article_id | string | Артикул произовдителя. |
offer[].sku | string | Артикул поставщика. |
offers[].quantity | integer | Количество товара доступное для заказа. |
offers[].price | float | Цена. |
offers[].store_id | string | Идентификатор точки выдачи. |
offers[].labels | object | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
|
stores | array | Список точек выдачи. Ключом является идентификатор точки выдачи. |
stores[].address | string | Адрес точки выдачи. |