Формат ответа
Формат ответа регулируется заголовком 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 | Процент износа товара бывшего в употреблении. |
Метки корзины
Для реализации логики разделения корзин например между клиентами пользователя API или по какому-то другому принципу может быть использован механизм уникального набора меток для каждой корзины.
Метки в запросах задаются через параметры, например: labels[foo]=1&labels[bar]=2.
Возможные варианты использования:
- при создании корзины (во время первого добавления товара) однократно задается уникальный набор меток, а потом используется cart_id полученный в результате;
- все взаимодействие с корзиной (добавление, изменение, удаление и получение) осуществляется посредством меток.
Методы
Получение токена для авторизации
POST /auth
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| login | string | да | Логин для входа в API. |
| password | string | да | Пароль для входа в API. |
Формат ответа
| Наименование поля | Тип | Описание |
|---|---|---|
| token | string | Токен для авторизации через Bearer Token. |
| expires | integer | Время (unixtime) окончания срока действия токена. |
Поиск артикулов производителей
GET /manufacturer/codes
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| code | string | да | Артикул производителя. |
| manufacturer_name | string | нет | Наименование производителя. Поддерживаются wildcards (например *knecht) при условии, что задан хотя бы один символ наименования (за исключением *). |
Формат ответа
Ответ возвращается в виде массива найденных артикулов.
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| code | 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 | Состояние товара. Возможные значения:
|
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| code | string | да | Артикул производителя. |
| replacements | boolean | нет | Возвращать ли товары-аналоги. |
| limit | integer | нет | Ограничение возвращенных строк из массива offers. По умолчанию 30. |
| offset | integer | нет | Возвращать строки из массива offers начиная с указанной позиции. По умолчанию 0. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| manufacturer_codes[] | array | да | Список найденный артикулов производителей. Возвращаются в виде ключ-значение. |
| manufacturer_codes[].code | string | да | Артикул производителя. |
| manufacturer_codes[].manufacturer | object | да | Описание компании-производителя. |
| manufacturer_codes[].manufacturer.id | string | да | Идентификатор компании-производителя. |
| manufacturer_codes[].manufacturer.name | string | да | Наименование компании-производителя. |
| manufacturer_codes[].media | object | нет | Список ссылок на медиафайлы с описанием товара. |
| manufacturer_codes[].media.images | array | да | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
| manufacturer_codes[].media.images[].url | string | да | Ссылка на полноразмерное изображения. |
| manufacturer_codes[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
| skus[] | array | да | Артикулы поставщика. |
| skus[].name | object | да | Наименование товара. |
| skus[].name.id | string | да | Идентификатор наименования товара. |
| skus[].name.name | string | да | Наименование товара. |
| skus[].condition | string | да | Состояние товара. |
| skus[].manufacturer_code | string | нет | Ключ описания товара производителя в manufacturer_codes[]. |
| skus[].comment | string | да | Комментарий к товару. |
| skus[].attributes | object | нет | Атрибуты товара. |
| skus[].media | object | нет | Список ссылок на медиафайлы с описанием товара. |
| skus[].media.images[] | array | нет | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
| skus[].media.images[].url | string | да | Ссылка на полноразмерное изображение. |
| skus[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
| offers[] | array | да | Список предложений. |
| offer[].sku | string | да | Артикул поставщика. |
| offers[].quantity | integer | да | Количество товара доступное для заказа. |
| offers[].price | float | да | Цена. |
| offers[].store | string | да | Ключ на описание склада в stores[] |
| offers[].labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
|
| stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. |
| stores[].address | string | да | Адрес. |
Информация о товаре по артикулу поставщика
GET /sku/{sku}
Параметры в URL
| Наименование | Тип | Параметры |
|---|---|---|
| sku | string | Артикул поставщика. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| condition | string | да | Состояние товара. |
| name | object | да | Наименование товара. |
| name.id | string | да | Идентификатор наименования товара. |
| name.name | string | да | Наименование. |
| comment | string | нет | Комментарий к товару. |
| manufacturer_code | object | нет | Описание товара от производителя. |
| manufacturer_code.code | string | да | Артикул производителя. |
| manufacturer_code.manufacturer | object | да | Описание производителя. |
| manufacturer_code.manufacturer.id | string | да | Идентификатор компании-производителя. |
| manufacturer_code.manufacturer.name | string | да | Наименование компании-производителя. |
| media | object | нет | Список ссылок на медиафайлы с описанием товара. |
| media.images[] | array | нет | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
| media.images[].url | string | да | Ссылка на полноразмерное изображение. |
| media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
| media.videos[] | array | нет | Список ссылок на видео-файлы. |
| media.videos[].url | string | да | Ссылка на видео. |
| media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). |
| compatibility | object | нет | Информация о совместимости товара с транспортными средствами и другими товарами. |
| compatibility.vehicles[] | array | нет | Список моделей транспортных средств, на которые подходит данный товар. |
| compatibility.vehicles[].id | string | да | Идентификтор модели. |
| compatibility.vehicles[].name | string | да | Наименование модели. |
| compatibility.vehicles[].years[] | array | да | Годы производства модели. |
| compatibility.vehicles[].years[0] | int | да | Год начала производства модели. Может быть null. |
| compatibility.vehicles[].years[1] | int | да | Год окончания производства модели. Может быть null в случае актуальных на данный момент моделей. |
| compatibility.vehicles[].manufacturer | object | да | Компания-производитель модели. |
| compatibility.vehicles[].manufacturer.id | string | да | Идентификатор компании-производителя. |
| compatibility.vehicles[].manufacturer.name | string | да | Наименование компании-производителя. |
| attributes | object | нет | Атрибуты товара. |
| contains | нет | Список товаров, которые включает данный. |
Добавление товара в корзину
POST /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров | Идентификатор корзины. |
| labels | object | ||
| offer_id | string | да | Идентификатор предложения. |
| quantity | int | да | Необходимое количество единиц товара. |
| price | float | нет | Стоимость товара. Может быть полезен, если нужна проверка актуальности цены например в случае кеширования данных на стороне клиента. В случае если товара нет по указанной цене, то вернется ошибка. Если параметр не указан, то товар будет добавлен в корзину по актуальной цене. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart_id | string | да | Идентификатор корзины. |
| cart_item_id | string | да | Идентификатор товара в корзине. |
Изменение количества товара в корзине
PUT /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. | Идентификатор корзины. |
| labels | object | ||
| offer_id | string | да | Идентификатор предложения. |
| quantity | int | да | Необходимое количество единиц товара. Данное значение заменит текущее количество единиц товара для указанного товара. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart_id | string | да | Идентификатор корзины. |
| cart_item_id | string | да | Идентификатор товара в корзине. |
Удаление товара из корзины
DELETE /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. | Идентификатор корзины. |
| labels | object | Метки корзины. | |
| offer_id | string | да | Идентификатор предложения. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart_id | string | да | Идентификатор корзины. |
| cart_item_id | string | да | Идентификатор товара в корзине. |