Формат ответа
Формат ответа регулируется заголовком 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 | нет | Возвращать ли товары-аналоги. |
| from | string | нет | Возвращать строки из массива offers после указанного offer_id. |
| limit | integer | нет | Ограничение возвращенных строк из массива offers. По умолчанию 30. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| 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 /offers/{offer_id}
Параметры в URL
| Наименование | Тип | Описание |
|---|---|---|
| offer_id | string | Идентификатор предложения |
Формат ответа
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| offer | object | да | Параметры предложения. |
| offer.id | string | да | Идентификатор предложения. |
| offer.store | string | да | Идентификатор склада. |
| offer.sku | string | да | Артикул. |
| offer.quantity | int | да | Количество единиц товара. |
| offer.price | float | да | Цена единицы товара. |
| offer.labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
|
| sku | object | да | |
| sku.condition | string | да | Состояние товара. |
| sku.name | object | да | Наименование товара. |
| sku.name.id | string | да | Идентификатор наименования товара. |
| sku.name.name | string | да | Наименование. |
| sku.comment | string | нет | Комментарий к товару. |
| sku.media | object | нет | Список ссылок на медиафайлы с описанием товара. |
| sku.media.images[] | array | нет | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
| sku.media.images[].url | string | да | Ссылка на полноразмерное изображение. |
| sku.media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
| sku.media.videos[] | array | нет | Список ссылок на видео-файлы. |
| sku.media.videos[].url | string | да | Ссылка на видео. |
| sku.media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). |
| sku.attributes | object | нет | Атрибуты товара. |
| manufacturer_code | object | нет | Описание товара от производителя. |
| manufacturer_code.code | string | да | Артикул производителя. |
| manufacturer_code.manufacturer | object | да | Описание производителя. |
| manufacturer_code.manufacturer.id | string | да | Идентификатор компании-производителя. |
| manufacturer_code.manufacturer.name | string | да | Наименование компании-производителя. |
| store | object | да | Описание склада. |
| store.id | string | да | Идентификатор склада. |
| store.address | string | да | Адрес склада. |
| store.phone | string | нет | Телефон склада. |
| store.coordinates[] | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
| delivery_types[] | array | да | Способы доставки. |
| delivery_types[].id | string | да | Идентификатор способа доставки. |
| delivery_types[].name | string | да | Название способа доставки. |
| delivery_types[].store | object | нет | Склад на который будет доставлен товар для самовывоза. |
| delivery_types[].store.id | string | да | Идентификатор склада. |
| delivery_types[].store.address | string | да | Адрес склада. |
| delivery_types[].store.phone | string | нет | Телефон склада. |
| delivery_types[].store.coordinates | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
Информация о товаре по артикулу поставщика
GET /sku/{sku}
Параметры в URL
| Наименование | Тип | Параметры |
|---|---|---|
| sku | string | Артикул поставщика. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| sku.condition | string | да | Состояние товара. |
| sku.name | object | да | Наименование товара. |
| sku.name.id | string | да | Идентификатор наименования товара. |
| sku.name.name | string | да | Наименование. |
| sku.comment | string | нет | Комментарий к товару. |
| sku.media | object | нет | Список ссылок на медиафайлы с описанием товара. |
| sku.media.images[] | array | нет | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
| sku.media.images[].url | string | да | Ссылка на полноразмерное изображение. |
| sku.media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
| sku.media.videos[] | array | нет | Список ссылок на видео-файлы. |
| sku.media.videos[].url | string | да | Ссылка на видео. |
| sku.media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). |
| sku.attributes | object | нет | Атрибуты товара. |
| manufacturer_code | object | нет | Описание товара от производителя. |
| manufacturer_code.code | string | да | Артикул производителя. |
| manufacturer_code.manufacturer | object | да | Описание производителя. |
| manufacturer_code.manufacturer.id | string | да | Идентификатор компании-производителя. |
| manufacturer_code.manufacturer.name | string | да | Наименование компании-производителя. |
| compatibility | object | нет | Совместимость товара. |
| compatibility.vehicle[] | array | нет | Совместимость товара с моделями автомобилей. |
| compatibility.vehicle[].id | string | да | Идентификатор модели. |
| compatibility.vehicle[].manufacturer | object | да | Описание производителя автомобиля. |
| compatibility.vehicle[].manufacturer.id | string | да | Идентификатор производителя. |
| compatibility.vehicle[].manufacturer.name | string | да | Наименование производителя. |
| compatibility.vehicle[].name | string | да | Наименование модели. |
| compatibility.vehicle[].years | array | да | Годы выпуска модели (0 - год начала выпуска, 1 - год окончания выпуска). Если первый элемент = null, то подразумевается выпуск с момента выпуска первого поколения модели. Если второй элемент = null, то подразумевается, что модель еще производится. |
Добавление товара в корзину
POST /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
| labels | object | Будет создана корзина с указанными метками, если ещё не существует. Если существует корзина, которая содержит указанные метки и явно не указан cart_id, то товар будет добавлен в неё. | |
| offer_id | string | да | Идентификатор предложения. |
| quantity | int | да | Необходимое количество единиц товара. |
| price | float | нет | Стоимость товара. Может быть полезен, если нужна проверка актуальности цены например в случае кеширования данных на стороне клиента. В случае если товара нет по указанной цене, то вернется ошибка. Если параметр не указан, то товар будет добавлен в корзину по актуальной цене. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart | object | да | Описание корзины. |
| cart.id | string | да | Идентификатор корзины. |
| cart.item | object | да | Описание товара в корзине. |
| cart.item.id | string | да | Идентификатор товара в корзине. |
| cart.item.quantity | int | да | Текущее количество единиц товара в корзине. |
| cart.item.price | float | да | Цена единицы товара товара. |
Изменение количества товара в корзине
PUT /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. | Идентификатор корзины. |
| labels | object | Изменение товара происходит в корзине содержащей указанный набор меток. Если будет найдено более одной корзины, то будет возвращена ошибка. | |
| offer_id | string | да | Идентификатор предложения. |
| quantity | int | да | Необходимое количество единиц товара. Данное значение заменит текущее количество единиц товара для указанного товара. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart | object | да | Описание корзины. |
| cart.id | string | да | Идентификатор корзины. |
| cart.item | object | да | Описание товара в корзине. |
| cart.item.id | string | да | Идентификатор товара в корзине. |
| cart.item.quantity | int | да | Текущее количество единиц товара в корзине. |
| cart.item.price | float | да | Цена единицы товара товара. |
Удаление товара из корзины
DELETE /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
| labels | object | Удаление товара происходит из корзины содержащей указанный набор меток. Если будет найдено более одной корзины, то будет возвращена ошибка. | |
| offer_id | string | да | Идентификатор предложения. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart | object | да | Описание корзины. |
| cart.id | string | да | Идентификатор корзины. |
| cart.item | object | да | Описание товара в корзине. |
| cart.item.id | string | да | Идентификатор товара в корзине. |
| cart.item.quantity | int | да | Текущее количество единиц товара в корзине. |
| cart.item.price | float | да | Цена единицы товара товара. |
Получение списка корзин
GET /cart
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
| labels | object | ||
| from | string | нет | Идентификатор корзины после которого вернуть записи. Порядок идентификаторов определяется порядком записей в результате запроса. Для того чтобы получить следующую порцию данных нужно указать последний идентификатор корзины в списке. |
| limit | int | нет | Вернуть указанное количество корзин. По умолчанию 10. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| carts[] | да | Список корзин. | |
| carts[].id | string | да | Идентификатор корзины. |
| carts[].labels | object | да | Метки корзины. |
| carts[].created_at | datetime | да | Дата создания корзины. |
| carts[].items | object | да | Информация о товарах в корзине. |
| carts[].items.number | int | да | Количество уникальных товаров в корзине. |
| carts[].items.price | float | да | Стоимость всех товаров в корзине. |
| cursor | object | да | Курсор. |
| cursor.from | string | да | Идентификатор записи после которой будут возвращены данные. |
| cursor.limit | int | да | Ограничение количества возвращаемых записей. |
Получение товаров в корзине
GET /cart/items
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
| labels | object |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| cart | object | да | Параметры корзины. |
| cart.id | string | да | Идентификатор корзины. |
| cart.labels | object | да | Метки корзины. |
| cart.created_at | datetime | да | Дата создания корзины. |
| cart.items | object | да | Информация о товарах в корзине. |
| cart.items.number | int | да | Количество уникальных товаров в корзине. |
| cart.items.price | float | да | Стоимость всех товаров в корзине. |
| items[] | array | да | Список товаров в корзине. |
| items[].id | string | да | Идентификатор товара в корзине. |
| items[].offer | string | да | Идентификатор предложения. |
| items[].store | string | да | Ключ описания склада в stores[]. |
| items[].quantity | int | да | Количество единиц товара. |
| items[].price | float | да | Цена единицы товара. |
| items[].sku | 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 | Список ссылок на медиафайлы с описанием товара. | ||
| skus[].media.images | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. | ||
| skus[].media.images.url | Ссылка на полноразмерное изображение. | ||
| skus[].media.images.thumbnail | Ссылка на миниатюру изображения. | ||
| manufacturer_codes[] | array | нет | Описание товара от производителя. |
| manufacturer_code[].code | string | да | Артикул производителя. |
| manufacturer_code[].manufacturer | object | да | Описание производителя. |
| manufacturer_code[].manufacturer.id | string | да | Идентификатор компании-производителя. |
| manufacturer_code[].manufacturer.name | string | да | Наименование компании-производителя. |
| skus[].media | Список ссылок на медиафайлы с описанием товара. | ||
| skus[].media.images | Список ссылок на изображения товара. В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. | ||
| skus[].media.images.url | Ссылка на полноразмерное изображение. | ||
| skus[].media.images.thumbnail | Ссылка на миниатюру изображения. | ||
| stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. |
| stores[].address | string | да | Адрес. |
Заказ товара по идентификатору предложения
POST /orders/offer
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| offer_id | string | да | Идентификатор предложения. |
| quantity | int | да | Необходимое количество товара. |
| price | float | нет | Цена товара. Если указано, то в случае наличия разницы с текущей ценой будет возвращена ошибка. Если не указано, то товар будет заказан по текущей цене. |
| delivery_type[id] | string | да | Идентификатор способа доставки. Возможные способы доставки можно получить при помощи метода получения информации о предложении. |
| delivery_type[comment] | string | нет | Комментарий к доставке. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| items | array | да | Список заказанной позиции. |
| items.id | string | да | Уникальный идентификатор позиции заказа. |
| items.order_id | string | да | Уникальный идентификатор заказа. |
| items.offer_id | string | да | Идентификатор предложения. |
| items.quantity | int | да | Количество единиц товара. |
| items.price | float | да | Цена единицы товара. |
Получение списка заказов
GET /orders
Параметры
| Наименование | Тип | Обязателен | Описание |
|---|---|---|---|
| date_start | datetime | нет | Минимальная дата создания заказа. |
| date_end | datetime | нет | Максимальная дата создания заказа. |
TODO from | string | нет | Идентификатор заказа начиная с которого нужно вернуть порцию данных. |
TODO limit | int | нет | Количество записей в порции данных. |
Формат ответа
| Наименование поля | Тип | Обязательно | Описание |
|---|---|---|---|
| items[] | array | да | Список заказанных позиций. |
| items[].order_id | string | да | Идентификатор заказа. |
| items[].quantity | int | да | Количество единиц товара. |
| items[].price | float | да | Цена единицы товара. |
| items[].sku | string | да | Артикул. |
| items[].created_at | datetime | да | Дата создания заказа. |
| items[].delivery | object | нет | Информация о доставке. |
| items[].delivery.expected_at | date|datetime | нет | Ориентировочная дата, до которой товар должен быть доставлен. |
| skus[] | array | да | Список артикулов. |
| skus[].name | object | да | Описание наименования товара. |
| skus[].name.id | string | да | Идентификатор наименования товара. |
| skus[].name.name | string | да | Наименование товара. |
| skus[].condition | string | да | Состояние товара. |
| skus[].comment | string | нет | Комментарий поставщика. |
| skus[].manufacturer_code | string | нет | Идентификатор из manufacturer_codes[] |
| 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 | да | Ссылка на миниатюру. |