Форматы ответа
Формат ответа регулируется заголовком 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 | Достигнуто максимальное количество запросов. |
Методы
Получение токена для авторизации
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/by_manufacturer_article/{manufacturer_id}/{manufacturer_article}
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| manufacturer_id | string | да | Идентификатор производителя. |
| manufacturer_article | string | да | Артикул производителя. |
| replacements | boolean | нет | Возвращать ли товары-аналоги. |
Формат ответа
| Наименование поля | Тип | Описание |
|---|---|---|
| manufacturer_articles | array | Список найденный артикулов производителей. Возвращаются в виде ключ-значение, ключом является уникальный идентификатор, по которому можно сопоставить элементы данного справочника с соответствующим полем в offers. |
| manufacturer_articles[].id | ||
| manufacturer_articles[].article | ||
| manufacturer_articles[].manufacturer | ||
| manufacturer_articles[].manufacturer.id | ||
| manufacturer_articles[].manufacturer.name | ||
| offers | array | Список предложений. |
| stores | array | Список точек выдачи. |