Table of Contents | ||
---|---|---|
|
Формат запроса
Адрес: https://whls.euroauto.ru/api.
Параметры запросов методами GET, DELETE нужно передавать в URL метода API.
Параметры запросов методами POST, PUT нужно отправлять в формате application/x-www-form-urlencoded в теле запроса.
Формат ответа
Формат ответа регулируется заголовком Accept.
Например: Accept: application/json.
Авторизационные данные (token), так же необходимо указывать в заголовке.
Например: Authorization: Bearer + token
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 | Достигнуто максимальное количество запросов. |
Anchor | ||||
---|---|---|---|---|
|
Наименование | Описание |
---|---|
new | Новый товар. |
used | Товар бывший в употреблении. Как правило в attributes.wear wearout указывается процент износа. |
Anchor | ||||
---|---|---|---|---|
|
Наименование | Тип | По умолчанию (нет в списке атрибутов товара) | Описание |
---|
wearout | int | Износа нет | Процент износа товара бывшего в употреблении. |
---|---|---|---|
weight | float | Вес неизвестен | Вес товара в кг. |
Anchor | ||||
---|---|---|---|---|
|
Для реализации логики разделения корзин например между клиентами пользователя API или по какому-то другому принципу может быть использован механизм уникального набора меток для каждой корзины.
...
- при создании корзины (во время первого добавления товара) однократно задается уникальный набор меток, а потом используется cart_id полученный в результате;
- все взаимодействие с корзиной (добавление, изменение, удаление и получение) осуществляется посредством меток.
...
Права пользователя
Название | Описание |
---|---|
retail_offers | Просмотр розничных предложений |
order | Заказ товаров |
Общие методы
Получение токена для авторизации
POST /auth
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
login | string | да | Логин для входа в API. |
password | string | да | Пароль для входа в API. |
Формат ответа
Наименование поля | Тип | Описание |
---|---|---|
token | string | Токен для авторизации через Bearer Token. |
expires | integer | Время (unixtime) окончания срока действия токена. |
...
Получение информации о пользователе
GET /manufacturer/codesuser
Формат ответа
Наименование поля | Тип | Обязателен | Описание |
---|
user |
---|
object | да |
Информация о текущем пользователе. |
permissions |
---|
object |
да |
Наименование производителя.
Поддерживаются wildcards (например *knecht) при условии, что задан хотя бы один символ наименования (за исключением *).
Формат ответа
Ответ возвращается в виде массива найденных артикулов.
Права пользователя. | |||
permissions.own[] | array | да | Права текущего пользователя. |
---|---|---|---|
permissions.granted[] | array | да | Права предоставленные другими пользователями. |
permissions.granted[].user | object | да | Информация о пользователе предоставившем права. |
permissions.granted[].user |
.id | string | да | Идентификатор |
---|
пользователя. |
permissions.granted[].user.name | string | да |
---|
Имя пользователя. |
permissions.granted[].permissions | array | да | Права предоставленные пользователем. |
---|---|---|---|
settings | object | да | Настройки пользователя. |
settings.watermark | string | нет | Префикс ватермарки для изображений. |
settings.cashless | integer | да | Тип оплаты на сайте. Возможные варианты: 0 - наличная оплата, 1 - безналичная оплата |
settings.delivery |
object | да |
Настройки доставки. | |||||||||
| array | да | Доставка по умолчанию. | ||||||
---|---|---|---|---|---|---|---|---|---|
settings.delivery.default[].offer_id |
string | да |
Получение товаров в наличии по артикулу производителя
GET /offers/manufacturer/{manufacturer_id}/{condition}
Параметры в URL
...
Состояние товара.
Возможные значения:
- new — новые товары;
- used — товары бывшие в употреблении.
Шаблон идентификатора предложения (wildcard). | |||
settings.delivery.default[].delivery | array | да | Способ доставки. |
---|---|---|---|
settings.delivery.default[].delivery.id | integer | да | Идентификатор способа доставки. |
settings.delivery.default[].delivery.comment | string | да | Комментарий. |
Получение списка складов
GET /stores
Формат ответа
Наименование поля |
---|
Параметры
Тип | Обязателен | Описание |
---|
stores[] |
---|
array | да |
Массив складов. |
stores[].id | string | да | Идентификатор. |
---|---|---|---|
stores[].name | string |
Ограничение возвращенных строк из массива offers.
По умолчанию 30.
Формат ответа
да | Наименование. | ||||
stores[].address | string | да | Адрес. | ||
---|---|---|---|---|---|
stores[].phone | string | нет | Телефон. | ||
stores[].coordinates | |||||
Наименование поля | Тип | Обязательно | Описание | ||
[] | array | да | Список найденный артикулов производителей. Возвращаются в виде ключ-значение. | нет | Массив координат ([широта, долгота]). |
stores[].delivery[] | array | да | Список идентификаторов способов доставки. | ||
delivery[] | array | да | Массив способов доставки (ключ = идентификатор способа доставки). | ||
delivery[].name | string | да | Наименование способа доставки. |
Получение способов доставки
GET /delivery/methods
Формат ответа
Наименование поля | Тип | Обязателен | Описание | ||||
---|---|---|---|---|---|---|---|
delivery[] | array | да | Массив способов доставки. | ||||
delivery[].id | string | да | Идентификатор. | ||||
delivery[] | |||||||
manufacturer_codes[].code | string | да | Артикул производителя. | ||||
manufacturer_codes[].manufacturer | object | да | Описание компании-производителя. | ||||
manufacturer_codes[].manufacturer.id | string | да | Идентификатор компании-производителя. | ||||
.name | string | да | Наименование компании-производителяНазвание. | ||||
manufacturer_codesdelivery[].mediapoint | object | нет | Список ссылок на медиафайлы с описанием товараОписание точки выдачи. | ||||
manufacturer_codesdelivery[].mediapoint.imagesid | arraystring | да | Список ссылок на изображения товара.
| Идентификатор точки. | |||
delivery[].point.name | string | да | Наименование точки. | ||||
delivery[].point.addressmanufacturer_codes[].media.images[].url | string | да | Ссылка на полноразмерное изображенияАдрес. | ||||
manufacturer_codesdelivery[].media.images[].thumbnailpoint.phone | string | данет | Ссылка на миниатюру изображенияТелефон. | ||||
skusdelivery[] | array | да | Артикулы поставщика. | skus.point.coordinates[].name | objectarray | да | Наименование товара. |
skus[].name.id | string | да | Идентификатор наименования товара. | ||||
skus[].name.name | string | да | Наименование товара. | ||||
нет | Массив способов доставки (ключ = идентификатор способа доставки). |
Поиск по артикулу и бренду
Поиск артикулов производителей
GET /products/manufacturers/codes
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
code | string | да |
Артикул производителя. |
manufacturer_ |
---|
name | string | нет |
---|
Список ссылок на изображения товара.
Note |
---|
В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
Метки присвоенные предложению поставщиком.
Здесь могут возвращаться например:
- название акции на товар;
- особенности заказа товара (оплата только за наличный расчет).
Список складов, на которых доступен данный товар.
Ключом является идентификатор точки выдачи.
Информация о предложении
...
Наименование производителя. Поддерживаются 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/products/manufacturers/{manufacturer_id}/{type}
Параметры в URL
Наименование | Описание |
---|---|
manufacturer_id | Идентификатор компании-производителя. |
type | Тип товара. Возможные значения:
|
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
code | string | да | Артикул производителя. |
replacements | boolean (true, false) | нет | Возвращать ли товары-аналоги. |
from | string | нет | Возвращать строки из массива offers после указанного offer_id. |
store_id[] | string[] | нет | Массив идентификаторов складов. |
delivery_id[] | string[] | нет | Массив идентификаторов способов доставки. |
limit | integer | нет | Ограничение возвращенных строк из массива offers. По умолчанию: 30. Максимальное значение: 101. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание | ||
---|---|---|---|---|---|
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 | да | Ссылка на миниатюру изображения. | ||
products[] | array | да | Артикулы поставщика. | ||
products[] |
...
Параметры в URL
...
Формат ответа
Наименование | Тип | Обязателен | Описание | ||
---|---|---|---|---|---|
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 | да | Наименование товара. | ||
skuproducts[].name.id | string | да | Идентификатор наименования товара. | ||
skuproducts[].name.name | string | да | Наименование товара. | ||
skuproducts[].commentcondition | string | нет | да | Состояние товараКомментарий к товару. | |
skuproducts[].manufacturer_code | objectstring | нет | Описание Ключ описания товара от производителя в manufacturer_codes[]. | ||
skuproducts[].manufacturersupplier_code.code | string | данет | Артикул производителяпоставщика. | ||
sku.manufacturer_code.manufacturer | object | да | Описание производителя. | ||
sku.manufacturer_code.manufacturer.id | string | да | Идентификатор компании-производителя. | ||
manufacturer_code.manufacturer.name | string | да | Наименование компании-производителя. | ||
Может быть указан например в документации к заказу. | |||||
products[].comment | string | да | Комментарий к товару. | ||
products[].attributes | object | нет |
| ||
products[]sku.media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
skuproducts[].media.images[] | array | нет | Список ссылок на изображения товара.
| ||
skuproducts[].media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||
skuproducts[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
products[].bundle | object | нет | Информация о принадлежности товара к комплекту. | ||
products[].bundle.containssku.media.videos[] | array | нет | Список ссылок на видео-файлы. | ||
sku.media.videos[].url | string | да | Ссылка на видео. | ||
sku.media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). | ||
sku.compatibility | object | нет | Информация о совместимости товара с транспортными средствами и другими товарами. | ||
sku.compatibility.vehicles[] | array | нет | Список моделей транспортных средств, на которые подходит данный товар. | ||
sku.compatibility.vehicles[].id | string | да | Идентификтор модели. | ||
sku.compatibility.vehicles[].name | string | да | Наименование модели. | ||
sku.compatibility.vehicles[].years[] | array | да | Годы производства модели. | ||
sku.compatibility.vehicles[].years[0] | int | да | Год начала производства модели. Может быть null. | ||
sku.compatibility.vehicles[].years[1] | int | да | Год окончания производства модели. Может быть null в случае актуальных на данный момент моделей. | ||
sku.compatibility.vehicles[].manufacturer | object | да | Компания-производитель модели. | ||
sku.compatibility.vehicles[].manufacturer.id | string | да | Идентификатор компании-производителя. | ||
sku.compatibility.vehicles[].manufacturer.name | string | да | Наименование компании-производителя. | ||
sku.attributes | object | нет | Атрибуты товара. | ||
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 | нет | Склад на который будет доставлен товар для самовывоза. | ||
идентификаторов товаров, которые содержит комплект. | |||||
products[].bundle.contained_in | array | нет | Список идентификаторов товаров-комплектов, которые содержат данный товар. | ||
products[].bundle.split | boolean (true, false) | да | true - позицию комплекта можно приобрести отдельно false - можно приобрести только комплект целиком | ||
offers[] | array | да | Список предложений. | ||
offers[].product_id | string | да | Артикул поставщика (ключ в products). | ||
offers[].quantity | integer | да | Количество товара доступное для заказа. | ||
offers[].price | float | да | Цена. | ||
offers[].store | string | да | Ключ описания склада в stores[]. | ||
offers[].labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
| ||
offers[].multiple | integer | да | Минимальная кратность для заказа. Проверяется в методах размещения в корзину и в заказ
| ||
stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. | ||
stores[].address | string | да | Адрес. |
Получение предложений по списку артикулов
GET /offers/products/{product_id,...}
Параметры в URL
Наименование | Тип | Описание | ||
---|---|---|---|---|
product_id | array | Список идентификаторов товаров разделенных запятой.
|
Формат ответа
Наименование поля | Тип | Обязательно | Описание | ||
---|---|---|---|---|---|
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 | да | Ссылка на миниатюру изображения. | ||
products[] | array | да | Артикулы поставщика. | ||
products[].name | object | да | Наименование товара. | ||
products[].name | delivery_types[].store.id | string | да | Идентификатор | складанаименования товара. | delivery_types
products[]. | storename. | addressname | string | да | Адрес складаНаименование товара. | delivery_types
products[]. | store.phonecondition | string | нетда | Телефон складаСостояние товара. | delivery_types|
products[]. | store.coordinatesarraymanufacturer_code | string | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
...
Ключ описания товара производителя в manufacturer_codes[]. | |||||
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. | ||
---|---|---|---|---|---|
products[].comment | string | да | Комментарий к товару. | ||
products[].attributes | object | нет |
| ||
products[].media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
products[].media.images[] | array | нет | Список ссылок на изображения товара.
| ||
products[].media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||
products[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
products[].bundle | object | нет | Информация о принадлежности товара к комплекту. | ||
products[].bundle.contains | array | нет | Список идентификаторов товаров, которые содержит комплект. | ||
products[].bundle.contained_in | array | нет | Список идентификаторов товаров-комплектов, которые содержат данный товар. | ||
products[].bundle.split | boolean (true, false) | да | true - позицию комплекта можно приобрести отдельно false - можно приобрести только комплект целиком | ||
offers[] | array | да | Список предложений. | ||
offers[].product_id | string | да | Артикул поставщика (ключ в products). | ||
offers[].quantity | integer | да | Количество товара доступное для заказа. | ||
offers[].price | float | да | Цена. | ||
offers[].store | string | да | Ключ описания склада в stores[]. | ||
offers[].labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
| ||
offers[].multiple | integer | да | Минимальная кратность для заказа. Проверяется в методах размещения в корзину и в заказ
| ||
stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. | ||
stores[].address | string | да | Адрес. | ||
delivery[] | array | да | Способы доставки. | ||
delivery[].id | string | да | Идентификатор способа доставки. | ||
delivery[].name | string | да | Название способа доставки. | ||
delivery[].store | object | нет | Склад на который будет доставлен товар для самовывоза. | ||
delivery[].store.id | string | да | Идентификатор склада. | ||
delivery[].store.address | string | да | Адрес склада. | ||
delivery[].store.phone | string | нет | Телефон склада. | ||
delivery[].store.coordinates | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
Получение списка артикулов по коду поставщика
Возвращает список артикулов (уникальных идентификаторов в рамках API) по внутреннему коду товара в системе поставщика.
Может быть полезен например при сверке получаемых товаров с товарами в заказе (в случае если поставщик указывает внутренней код в API и документации к заказу).
GET /products/suppliers/codes
GET /sku/{sku}
Параметры в URL
...
Формат ответа
...
Список ссылок на изображения товара.
Note |
---|
В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
...
Год начала производства модели.
Может быть null.
...
Год окончания производства модели.
Может быть null в случае актуальных на данный момент моделей.
...
contains Status colour Yellow title TODO
...
Добавление товара в корзину
POST /cart
...
Наименование | Тип | Обязателен | Описание |
---|
type | string |
---|
Обязателен как минимум один из параметров.
Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам.
Идентификатор корзины.
Будет создана корзина с указанными метками, если ещё не существует.
Если существует корзина, которая содержит указанные метки и явно не указан cart_id, то товар будет добавлен в неё.
да | Тип товара. used - б/у товары | ||
code | string | да | Код поставщика. Обычно указывается в products[].supplier_code. |
---|
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
products[] | array | да | Массив найденных артикулов. |
products[].id | string | да |
Артикул поставщика. |
products[] |
---|
array | да |
Артикулы поставщика. |
Стоимость товара.
Может быть полезен, если нужна проверка актуальности цены например в случае кеширования данных на стороне клиента.
В случае если товара нет по указанной цене, то вернется ошибка.
Если параметр не указан, то товар будет добавлен в корзину по актуальной цене.
Формат ответа
...
Изменение количества товара в корзине
PUT /cart
Параметры
...
Обязателен как минимум один из параметров.
Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам.
...
Изменение товара происходит в корзине содержащей указанный набор меток.
Если будет найдено более одной корзины, то будет возвращена ошибка.
...
Необходимое количество единиц товара.
Данное значение заменит текущее количество единиц товара для указанного товара.
products[].name | object | да | Наименование товара. |
---|---|---|---|
products[].name.id | string | да | Идентификатор наименования товара. |
products[].name.name | string | да | Наименование товара. |
products[].condition | string | да | Состояние товара. |
products[].manufacturer_code | string | нет | Ключ описания товара производителя в manufacturer_codes[]. |
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. |
products[].comment | string | да | Комментарий к товару. |
products[].attributes | object | нет | |
products[].media | object | нет | Список ссылок на медиафайлы с описанием товара. |
products[].media.images[] | array | нет | Список ссылок на изображения товара. |
products[].media.images[].url | string | да | Ссылка на полноразмерное изображение. |
products[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
products[].bundle | object | нет | Информация о принадлежности товара к комплекту. |
products[].bundle.contains | array | нет | Список идентификаторов товаров, которые содержит комплект. |
products[].bundle.contained_in | array | нет | Список идентификаторов товаров-комплектов, которые содержат данный товар. |
products[].bundle.split | boolean (true, false) | да | true - позицию комплекта можно приобрести отдельно false - можно приобрести только комплект целиком |
Полная информация по конкретному предложению
Получение информации о списке предложений
GET /v3/offers
GET /v3/offers/<offer_id>
Получение одного предложения: /v2/offers/5-1037-1414608-0-0.
Получение нескольких предложений: /v2/offers?offer_ids[]=5-1037-1414608-0-0&offer_ids[]=5-1037-1414610-0-0.
Параметры в URL
Наименование | Тип | Описание | ||
---|---|---|---|---|
offer_id | array | Список идентификаторов предложений разделенных запятой.
|
Параметры
Наименование | Тип | Описание | ||
---|---|---|---|---|
offer_ids | array | Список идентификаторов предложений разделенных запятой.
|
Формат ответа
Наименование поля | Тип | Обязательно | Описание | ||
---|---|---|---|---|---|
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 | да | Ссылка на миниатюру изображения. | ||
products[] | array | да | Артикулы поставщика. | ||
products[].name | object | да | Наименование товара. | ||
products[].name.id | string | да | Идентификатор наименования товара. | ||
products[].name.name | string | да | Наименование товара. | ||
products[].condition | string | да | Состояние товара. | ||
products[].manufacturer_code | string | нет | Ключ описания товара производителя в manufacturer_codes[]. | ||
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. | ||
products[].comment | string | да | Комментарий к товару. | ||
products[].attributes | object | нет |
| ||
products[].media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
products[].media.images[] | array | нет | Список ссылок на изображения товара.
| ||
products[].media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||
products[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
products[].bundle | object | нет | Информация о принадлежности товара к комплекту. | ||
products[].bundle.contains | array | нет | Список идентификаторов товаров, которые содержит комплект. | ||
products[].bundle.contained_in | array | нет | Список идентификаторов товаров-комплектов, которые содержат данный товар. | ||
products[].bundle.split | boolean (true, false) | да | true - позицию комплекта можно приобрести отдельно false - можно приобрести только комплект целиком | ||
offers[] | array | да | Список предложений. | ||
offers[].product_id | string | да | Артикул поставщика (ключ в products). | ||
offers[].quantity | integer | да | Количество товара доступное для заказа. | ||
offers[].price | float | да | Цена. | ||
offers[].store | string | да | Ключ описания склада в stores[]. | ||
offers[].labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
| ||
offers[].multiple | integer | да | Минимальная кратность для заказа. Проверяется в методах размещения в корзину и в заказ
| ||
stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. | ||
stores[].address | string | да | Адрес. | ||
delivery[] | array | да | Способы доставки. | ||
delivery[].id | string | да | Идентификатор способа доставки. | ||
delivery[].name | string | да | Название способа доставки. | ||
delivery[].offers[] | array | да | Список параметров доставки для каждого предложения. Ключом является идентификатор предложения. | ||
delivery[].offers[<offer_id>].time | array | нет | Информация о времени доставки. | ||
delivery[].offers[<offer_id>].time.min | integer | да | Предполагаемое минимальное время доставки в формате unixtime.
| ||
delivery[].point | object | нет | Склад на который будет доставлен товар для самовывоза. | ||
delivery[].point.id | string | да | Идентификатор склада. | ||
delivery[].point.address | string | да | Адрес склада. | ||
delivery[].point.phone | string | нет | Телефон склада. | ||
delivery[].point.coordinates | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
Информация о предложении
Anchor | ||||
---|---|---|---|---|
|
Параметры в URL
Наименование | Тип | Описание |
---|---|---|
offer_id | string | Идентификатор предложения |
Формат ответа
Наименование | Тип | Обязателен | Описание | ||
---|---|---|---|---|---|
offer | object | да | Параметры предложения. | ||
offer.id | string | да | Идентификатор предложения. | ||
offer.store | string | да | Идентификатор склада. | ||
offer.product_id | string | да | Артикул. | ||
offer.quantity | int | да | Количество единиц товара. | ||
offer.price | float | да | Цена единицы товара. | ||
offer.labels | object | нет | Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
| ||
offer.multiple | integer | да | Минимальная кратность для заказа. Проверяется в методах размещения в корзину и в заказ
| ||
product | object | да | |||
product.condition | string | да | Состояние товара. | ||
product.name | object | да | Наименование товара. | ||
product.name.id | string | да | Идентификатор наименования товара. | ||
product.name.name | string | да | Наименование. | ||
product.comment | string | нет | Комментарий к товару. | ||
product.media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
product.media.images[] | array | нет | Список ссылок на изображения товара.
| ||
product.media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||
product.media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
product.media.videos[] | array | нет | Список ссылок на видео-файлы. | ||
product.media.videos[].url | string | да | Ссылка на видео. | ||
product.media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). | ||
product.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[] | array | да | Способы доставки. | ||
delivery[].id | string | да | Идентификатор способа доставки. | ||
delivery[].name | string | да | Название способа доставки. | ||
delivery[].point | object | нет | Склад на который будет доставлен товар для самовывоза. | ||
delivery[].point.id | string | да | Идентификатор склада. | ||
delivery[].point.address | string | да | Адрес склада. | ||
delivery[].point.phone | string | нет | Телефон склада. | ||
delivery[].point.coordinates | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота |
Anchor | ||||
---|---|---|---|---|
|
GET /products/{product_id}
Параметры в URL
Наименование | Тип | Параметры |
---|---|---|
product_id | string | Артикул поставщика. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
product.condition | string | да | Состояние товара. |
product.name | object | да | Наименование товара. |
product.name.id | string | да | Идентификатор наименования товара. |
product.name.name | string | да | Наименование. |
product.comment | string | нет | Комментарий к товару. |
product.media | object | нет | Список ссылок на медиафайлы с описанием товара. |
product.media.images[] | array | нет | Список ссылок на изображения товара. |
product.media.images[].url | string | да | Ссылка на полноразмерное изображение. |
product.media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. |
product.media.videos[] | array | нет | Список ссылок на видео-файлы. |
product.media.videos[].url | string | да | Ссылка на видео. |
product.media.videos[].thumbnail | string | да | Ссылка на миниатюру видео (обычно в формате image/gif). |
product.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 /carts/offers/{offer_id}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
Параметры
Наименование | Тип | Обязателен | Описание | ||
---|---|---|---|---|---|
cart_id | string | Нет, если не указан ни один из параметров, то будет создана новая корзина. | Идентификатор корзины. | ||
labels | object | Будет создана корзина с указанными метками, если ещё не существует. Если существует корзина, которая содержит указанные метки и явно не указан cart_id, то товар будет добавлен в неё. | |||
quantity | int | да | Необходимое количество единиц товара. Учитывайте минимальную кратность для заказа (multiple).
| ||
price | float | нет | Стоимость товара. Может быть полезен, если нужна проверка актуальности цены например в случае кеширования данных на стороне клиента. В случае если товара нет по указанной цене, то вернется ошибка. Если параметр не указан, то товар будет добавлен в корзину по актуальной цене. | ||
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
cart | object | да | Описание корзины. |
cart.id | string | да | Идентификатор корзины. |
item | object | да | Описание товара в корзине. |
item.id | string | да | Идентификатор товара в корзине. |
item.quantity | int | да | Текущее количество единиц товара в корзине. |
item.price | float | да | Цена единицы товара товара. |
Изменение количества товара в корзине
PUT /carts/offers/{offer_id}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
Параметры
Наименование | Тип | Обязателен | Описание | ||
---|---|---|---|---|---|
cart_id | string | Обязателен как минимум один из параметров. | Идентификатор корзины. | ||
labels | object | Изменение товара происходит в корзине содержащей указанный набор меток. Если будет найдено более одной корзины, то изменения будут применены ко всем корзинам. | |||
quantity | int | да | Необходимое количество единиц товара. Данное значение заменит текущее количество единиц товара для указанного товара. Учитывайте минимальную кратность для заказа (multiple).
| ||
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
cart | array | да | Описание корзины. |
cart.id | string | да | Идентификатор корзины. |
cart.labels | object | да | Метки корзины. |
item | object | да | Описание товара в корзине. |
item.id | string | да | Идентификатор товара в корзине. |
item.offer_id | string | да | Идентификатор предложения. |
item.quantity | int | да | Текущее количество единиц товара в корзине. |
item.price | float | да | Цена единицы товара товара. |
Удаление товара из корзины
DELETE /carts/offers/{offer_id}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
labels | object | Удаление товара происходит из корзины содержащей указанный набор меток. Если будет найдено более одной корзины, то товар с указанным offer_id будет удален из всех корзин. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
cart | array | да | Описание корзины. |
cart.id | string | да | Идентификатор корзины. |
cart.labels | object | да | Метки корзины. |
item | object | да | Описание товара в корзине. |
item.id | string | да | Идентификатор товара в корзине. |
item.offer_id | string | да | Идентификатор предложения. |
Получение списка корзин
GET /carts
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
cart_id | string | Нет, если не указан ни один из параметров, то будут возвращены все корзины пользователя. | Идентификатор корзины. |
labels | object | ||
from | string | нет | Идентификатор корзины после которого вернуть записи. Порядок идентификаторов определяется порядком записей в результате запроса. Для того чтобы получить следующую порцию данных нужно указать последний идентификатор корзины в списке. |
limit | int | нет | Вернуть указанное количество корзин. По умолчанию 10. |
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
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 /carts/items
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
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[].product_id | string | да | Артикулы поставщиков. | ||
products[] | array | да | Артикулы поставщика. | ||
products[].name | object | да | Наименование товара. | ||
products[].name.id | string | да | Идентификатор наименования товара. | ||
products[].name.name | string | да | Наименование товара. | ||
products[].condition | string | да | Состояние товара. | ||
products[].manufacturer_code | string | нет | Ключ описания товара производителя в manufacturer_codes[]. | ||
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. | ||
products[].comment | string | нет | Комментарий к товару. | ||
products[].attributes | object | нет | Атрибуты товара. | ||
products[].media | Список ссылок на медиафайлы с описанием товара. | ||||
products[].media.images | Список ссылок на изображения товара.
| ||||
products[].media.images.url | Ссылка на полноразмерное изображение. | ||||
products[].media.images.thumbnail | Ссылка на миниатюру изображения. | ||||
manufacturer_codes[].manufacturer.id | string | да | Идентификатор компании-производителя. | ||
manufacturer_codes[].manufacturer.name | string | да | Наименование компании-производителя. | ||
manufacturer_codes[].media | Список ссылок на медиафайлы с описанием товара. | ||||
manufacturer_codes[].media.images | Список ссылок на изображения товара.
| ||||
manufacturer_codes[].media.images.url | Ссылка на полноразмерное изображение. | ||||
manufacturer_codes[].media.images.thumbnail | Ссылка на миниатюру изображения. | ||||
stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. | ||
stores[].address | string | да | Адрес. | ||
delivery[] | array | да | Способы доставки. | ||
delivery[].id | string | да | Идентификатор способа доставки. | ||
delivery[].name | string | да | Название способа доставки. | ||
delivery[].store | object | нет | Склад на который будет доставлен товар для самовывоза. | ||
delivery[].store.id | string | да | Идентификатор склада. | ||
delivery[].store.address | string | да | Адрес склада. | ||
delivery[].store.phone | string | нет | Телефон склада. | ||
delivery[].store.coordinates | array | нет | Координаты. coordinates[0] - широта coordinates[0] - долгота | ||
delivery[].offers[<offer_id>].time | array | нет | Информация о времени доставки. | ||
delivery[].offers[<offer_id>].time.min | integer | да | Предполагаемое минимальное время доставки в формате unixtime. Расчёт времени на данный момент находится в процессе реализации, параметр возвращается для упрощения интеграций предполагающих его использование. |
Удаление корзин
DELETE /carts
DELETE /carts/{cart_id}
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
labels | object |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
cart | array | да | Описание корзины. |
cart.id | string | да | Идентификатор корзины. |
cart.labels | object | да | Метки корзины. |
items[] | array | да | Список позиций. |
items[].offer_id | string | да | Идентификатор предложения. |
Заказ товара
Заказ товара по идентификатору предложения
POST /orders/offers/{offer_id}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
Параметры
Наименование | Тип | Обязателен | Описание | ||
---|---|---|---|---|---|
offer_id | string | да | Идентификатор предложения. | ||
quantity | int | да | Необходимое количество единиц товара. Учитывайте минимальную кратность для заказа (multiple).
| ||
price | float | нет | Цена товара. Если указано, то в случае наличия разницы с текущей ценой будет возвращена ошибка. Если не указано, то товар будет заказан по текущей цене. | ||
delivery[id] | string | нет | Идентификатор способа доставки. Возможные способы доставки можно получить при помощи метода получения информации о предложении. Если не указан, то будет использован способ доставки по умолчанию. | ||
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
orders[] | array | да | Массив созданных заказов. Ключом массива является идентификатор заказа (string). |
orders[].delivery | object | да | Способ доставки. |
orders[].delivery.id | string | да | Идентификатор способа доставки. |
orders[].delivery.name | string | да | Наименование способа доставки. |
orders[].delivery.price | float | нет | Стоимость доставки. |
items[] | array | да | Список заказанной позиции. |
items[].id | string | да | Уникальный идентификатор позиции заказа. |
items[].order | object | да | Параметры заказа. |
items[].order.id | string | да | Уникальный идентификатор заказа. |
items[].offer_id | string | да | Идентификатор предложения. |
items[].quantity | int | да | Количество единиц товара. |
items[].price | float | да | Цена единицы товара. |
offers[] | array | да | Список предложений. |
offers[].store_id | string | да | Идентификатор склада. |
offers[].product_id | string | да | Идентификатор артикула поставщика. |
offers[].quantity | integer | да | Доступное количество товара. |
offers[].price | float | да | Стоимость товара. |
products[] | array | да | Массив артикулов поставщика. |
products[].name | string | да | Наименование товара. |
products[].name.id | string | да | Идентификатор наименования товара. |
products[].name.name | string | да | Наименование товара. |
products[].condition | string | да | Состояние товара. |
products[].comment | string | нет | Комментарий поставщика. |
products[].manufacturer_code | string | нет | Идентификатор артикула производителя. |
manufacturer_codes[] | array | да | Массив артикулов производителя. |
manufacturer_codes[].code | string | да | Артикул производителя. |
manufacturer_codes[].manufacturer | object | да | Производитель товара. |
manufacturer_codes[].manufacturer.id | string | да | Идентификатор производителя. |
manufacturer_codes[].manufacturer.name | string | да | Наименование производителя. |
manufacturer_codes[].name | object | да | Наименование товара. |
manufacturer_codes[].name.id | string | да | Идентификатор наименования товара. |
manufacturer_codes[].name.name | string | да | Наименование товара. |
manufacturer_codes[].media | object | нет | Медиа-файлы. |
manufacturer_codes[].media.images[] | array | нет | Изображения товара. |
manufacturer_codes[].media.images[].url | string | да | Адрес полноразмерного изображения. |
manufacturer_codes[].media.images[].thumbnail | string | да | Адрес миниатюры изображения. |
stores[] | array | да | Массив складов. Ключом является идентификатор склада. |
stores[].name | string | да | Наименование склада. |
stores[].address | string | нет | Адрес склада. |
stores[].phone | string | нет | Телефон склада. |
stores[].coordinates[] | array | нет | Координаты склада в виде массива [широта, долгота]. |
Предварительный просмотр заказа товара по идентификатору предложения
POST /orders/offers/{offer_id}/preview
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
offer_id | string | да | Идентификатор предложения. |
quantity | int | да | Необходимое количество товара. |
price | float | нет | Цена товара. Если указано, то в случае наличия разницы с текущей ценой будет возвращена ошибка. Если не указано, то товар будет заказан по текущей цене. |
delivery[id] | string | нет | Идентификатор способа доставки. Возможные способы доставки можно получить при помощи метода получения информации о предложении. Если не указан, то будет использован способ доставки по умолчанию. |
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Ответ аналогичен методу "Заказ товара по идентификатору предложения".
Заказ товаров из корзины
POST /orders/carts
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
labels | object | Метки корзины. | |
delivery[id] | string | нет | Идентификатор способа доставки. Возможные способы доставки можно получить при помощи метода получения информации о предложении. Если не указан, то будет использован способ доставки по умолчанию. |
offer_ids[] | array | нет | Заказ только указанных предложений. Пример (application/x-www-form-urlencoded): offer_ids[]=a&offer_ids[]=b. |
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
orders[] | array | да | Массив созданных заказов. Ключом массива является идентификатор заказа (string). |
orders[].delivery | object | да | Способ доставки. |
orders[].delivery.id | string | да | Идентификатор способа доставки. |
orders[].delivery.name | string | да | Наименование способа доставки. |
orders[].delivery.price | float | нет | Стоимость доставки. |
items[].quantity | int | да | Количество единиц товара. |
items[].price | float | да | Цена единицы товара. |
offers[] | array | да | Список предложений. |
offers[].store_id | string | да | Идентификатор склада. |
offers[].product_id | string | да | Идентификатор артикула поставщика. |
offers[].quantity | integer | да | Доступное количество товара. |
offers[].price | float | да | Стоимость товара. |
products[] | array | да | Массив артикулов поставщика. |
products[].name | string | да | Наименование товара. |
products[].name.id | string | да | Идентификатор наименования товара. |
products[].name.name | string | да | Наименование товара. |
products[].condition | string | да | Состояние товара. |
products[].comment | string | нет | Комментарий поставщика. |
products[].manufacturer_code | string | нет | Идентификатор артикула производителя. |
manufacturer_codes[] | array | да | Массив артикулов производителя. |
manufacturer_codes[].code | string | да | Артикул производителя. |
manufacturer_codes[].manufacturer | object | да | Производитель товара. |
manufacturer_codes[].manufacturer.id | string | да | Идентификатор производителя. |
manufacturer_codes[].manufacturer.name | string | да | Наименование производителя. |
manufacturer_codes[].name | object | да | Наименование товара. |
manufacturer_codes[].name.id | string | да | Идентификатор наименования товара. |
manufacturer_codes[].name.name | string | да | Наименование товара. |
manufacturer_codes[].media | object | нет | Медиа-файлы. |
manufacturer_codes[].media.images[] | array | нет | Изображения товара. |
manufacturer_codes[].media.images[].url | string | да | Адрес полноразмерного изображения. |
manufacturer_codes[].media.images[].thumbnail | string | да | Адрес миниатюры изображения. |
stores[] | array | да | Массив складов. Ключом является идентификатор склада. |
stores[].name | string | да | Наименование склада. |
stores[].address | string | нет | Адрес склада. |
stores[].phone | string | нет | Телефон склада. |
stores[].coordinates[] | array | нет | Координаты склада в виде массива [широта, долгота]. |
Предварительный просмотр заказа товаров из корзины
POST /orders/carts/preview
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
cart_id | string | Обязателен как минимум один из параметров. Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам. | Идентификатор корзины. |
labels | object | Метки корзины. | |
delivery[id] | string | нет | Идентификатор способа доставки. Возможные способы доставки можно получить при помощи метода получения информации о предложении. Если не указан, то будет использован способ доставки по умолчанию. |
offer_ids[] | array | нет | Заказ только указанных предложений. Пример (application/x-www-form-urlencoded): offer_ids[]=a&offer_ids[]=b. |
become | string | нет | Идентификатор пользователя, для которого нужно создать заказ. |
Формат ответа
Ответ аналогичен методу "Заказ товаров из корзины".
Получение списка заказанных товаров
GET /orders/items
Параметры
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
date_start | datetime | да | Минимальная дата создания заказа. |
date_end | datetime | да | Максимальная дата создания заказа. |
become | string | нет | Идентификатор пользователя создавшего заказы. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
items[] | array | да | Список заказанных позиций. |
items[].order_id | string | да | Идентификатор заказа. |
items[].quantity | int | да | Количество единиц товара. |
items[].price | float | да | Цена единицы товара. |
items[].product_id | string | да | Артикул. |
items[].created_at | datetime | да | Дата создания заказа. |
items[].delivery | object | нет | Информация о доставке. |
items[].delivery.expected_at | date|datetime | нет | Ориентировочная дата, до которой товар должен быть доставлен. |
items[].state | object | да | Состояние заказа. |
items[].state.name | string | да | Наименование статуса заказа. |
items[].state.attributes | array | нет | Атрибуты статусов. |
products[] | array | да | Список артикулов. |
products[].name | object | да | Описание наименования товара. |
products[].name.id | string | да | Идентификатор наименования товара. |
products[].name.name | string | да | Наименование товара. |
products[].condition | string | да | Состояние товара. |
products[].comment | string | нет | Комментарий поставщика. |
products[].manufacturer_code | string | нет | Идентификатор из manufacturer_codes[] |
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. |
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 | да | Ссылка на миниатюру. |
Отмена заказа
DELETE /orders/items/{item_id}
Note |
---|
Заказ будет отменен только в случае наличия такой возможности (в основном зависит от статуса). |
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
item_id | string | да | Идентификатор позиции заказа. |
become | string | нет | Идентификатор пользователя создавшего заказ. |
Построение каталога поиска по марке/модели
Получение брендов-производителей транспортных средств
GET /vehicles/manufacturers
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
manufacturers[].id | string | да | Идентификатор производителя. |
manufacturers[].name | string | да | Наименование производителя. |
manufacturers[].country | object | нет | Описание страны. |
manufacturers[].country.name | string | нет | Наименование страны. |
menufacturers[].models | object | нет | Информация о моделях транспортных средств. |
manufacturers[].models.types | array | да | Список типов моделей. cars - легковые trucks - грузовые/автобусы moto - мототехника |
Пример ответа
Code Block | ||||
---|---|---|---|---|
| ||||
{
"data": {
"manufacturers": [
{
"id": "35",
"name": "Acura",
"country": {
"name": "Япония"
},
"models": {
"types": [
"car"
]
}
},
{
"id": "59",
"name": "Alfa Romeo",
"country": {
"name": "Италия"
},
"models": {
"types": [
"car"
]
}
}
}
} |
Получение моделей транспортных средств
GET /vehicles/manufacturers/{manufacturer_id}/models
GET /vehicles/manufacturers/{manufacturer_id}/models/{type}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
manufacturer_id | string | да | Идентификатор производителя. |
type | string | нет | Тип транспортного средства. car - легковые truck - грузовые/прицепы/автобусы moto - мототехника |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
models[].id | string | да | Идентификатор производителя. |
models[].type | string | да | Типа транспортного средства. car - легковые truck - грузовые/прицепы/автобусы moto - мототехника |
models[].name | string | да | Наименование производителя. |
models[].manufacturer | object | да | Описание страны. |
models[].manufacturer.id | string | да | |
models[].manufacturer.name | string | да | Наименование страны. |
models[].years | array | нет | 0 - дата начала выпуска модели 1 - дата окончания выпуска модели |
models[].media | object | нет | Список медиа-файлов. |
models[].media.images[] | array | да | Список изображений модели. |
models[].media.images[].url | string | да | URL изображения. |
Получение категорий товаров по модели транспортного средства
GET /products/categories/vehicles/models/{model_id}
Параметры в URL
Наименование | Тип | Обязателен | Описание |
---|---|---|---|
model_id | string | да | Идентификатор модели транспортного средства. |
Формат ответа
Наименование поля | Тип | Обязательно | Описание |
---|---|---|---|
categories[] | array | да | Список категорий. |
categories[].id | string | да | Идентификатор категории. |
categories[].name | string | да | Наименование категории. |
categories[].offers | object | да | Информация о предложениях товаров данной категории. |
categories[].offers.types | array | да | Типы предложений (new, used). |
categories[].searchable | boolean (true, false) | да | Возможен ли поиск по данной категории. |
categories[].parent | object | нет | Категория, к которой принадлежит данная подкатегория. |
categories[].parent.id | string | нет | Идентификатор категории, к которой принадлежит данная подкатегория. |
Получение товаров в наличии по модели и наименованию товара
GET /offers/vehicles/models/{model_id}/{type}
Параметры в URL
Наименование | Описание |
---|---|
model_id | Идентификатор модели транспортного средства. |
type | Тип товара. Возможные значения:
|
Формат ответа
...
Удаление товара из корзины
DELETE /cart
Параметры
...
Обязателен как минимум один из параметров.
Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам.
...
Удаление товара происходит из корзины содержащей указанный набор меток.
Если будет найдено более одной корзины, то будет возвращена ошибка.
...
Формат ответа
...
Получение списка корзин
GET /cart
Параметры
...
Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам.
...
...
Идентификатор корзины после которого вернуть записи.
Порядок идентификаторов определяется порядком записей в результате запроса.
Для того чтобы получить следующую порцию данных нужно указать последний идентификатор корзины в списке.
...
Вернуть указанное количество корзин.
По умолчанию 10.
Формат ответа
...
Получение товаров в корзине
GET /cart/items
Параметры
...
Если указаны оба, то поиск корзины будет произведен и по cart_id, и по меткам.
...
Формат ответа
...
Список ссылок на изображения товара.
Note |
---|
В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
...
Список ссылок на изображения товара.
Note |
---|
В результате данного метода возвращается только одна ссылка на фото, полный список доступен в полной информации о товаре. |
...
Список складов, на которых доступен данный товар.
Ключом является идентификатор точки выдачи.
...
Заказ товара по идентификатору предложения
...
Параметры
Наименование | Тип | Обязателен | Описание |
---|
category_id | string | да | Идентификатор |
---|
категории товара. |
from |
---|
string |
Цена товара.
Если указано, то в случае наличия разницы с текущей ценой будет возвращена ошибка.
Если не указано, то товар будет заказан по текущей цене.
Идентификатор способа доставки.
Возможные способы доставки можно получить при помощи метода получения информации о предложении.
нет | Возвращать строки из массива offers после указанного offer_id. | ||
store_id[] | string[] | нет | Массив идентификаторов складов. |
---|---|---|---|
delivery_id[] | string[] | нет | Массив идентификаторов способов доставки. |
limit | integer | нет | Ограничение возвращенных строк из массива offers. По умолчанию: 30. Максимальное значение: 101. |
Формат ответа
Наименование поля | Тип | Обязательно | Описаниеitems | ||
---|---|---|---|---|---|
manufacturer_codes[] | array | да | Список заказанной позиции.найденный артикулов производителей. Возвращаются в виде ключ-значение. | ||
manufacturer_codes[].code | items.idstring | да | Уникальный идентификатор позиции заказа. | items.order_Артикул производителя. | |
manufacturer_codes[].manufacturer | object | да | Описание компании-производителя. | ||
manufacturer_codes[].manufacturer.id | string | да | Идентификатор компании-производителя. | ||
manufacturer_codes[].manufacturer.name | Уникальный идентификатор заказа. | items.offer_id | string | да | Идентификатор предложенияНаименование компании-производителя. |
items.quantity | int | да | Количество единиц товара. | ||
items.price | float | да | Цена единицы товара. |
Получение списка заказов
GET /orders
Параметры
...
from Status colour Yellow title TODO
...
limit Status colour Yellow title TODO
...
manufacturer_codes[].media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
---|---|---|---|---|---|
manufacturer_codes[].media.images | array | да | Список ссылок на изображения товара.
| ||
manufacturer_codes[].media.images[].url | string | да | Ссылка на полноразмерное изображения. | ||
manufacturer_codes[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
products[] | array | да | Артикулы поставщика. | ||
products[].name | object | да | Наименование товара. | ||
products[].name.id | string | да | Идентификатор наименования товара. | ||
products[].name.name | string | да | Наименование товара. | ||
products[].condition | string | да | Состояние товара. | ||
products[].manufacturer_code | string | нет | Ключ описания товара производителя в manufacturer_codes[]. | ||
products[].supplier_code | string | нет | Артикул поставщика. Может быть указан например в документации к заказу. | ||
products[].comment | string | да | Комментарий к товару. | ||
products[].attributes | object | нет |
| ||
products[].media | object | нет | Список ссылок на медиафайлы с описанием товара. | ||
products[].media.images[] | array | нет | Список ссылок на изображения товара.
| ||
products[].media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||
products[].media.images[].thumbnail | string | да | Ссылка на миниатюру изображения. | ||
products[].bundle | object | нет | Информация о принадлежности товара к комплекту. | ||
products[].bundle.contains | array | нет | Список идентификаторов товаров, которые содержит комплект. | ||
products[].bundle.contained_in | array | нет | Список идентификаторов товаров-комплектов, которые содержат данный товар. | ||
products[].bundle.split | boolean (true, false) | да | true - позицию комплекта можно приобрести отдельно false - можно приобрести только комплект целиком | ||
offers |
Формат ответа
Наименование поля | Тип | Обязательно | Описание | ||||
---|---|---|---|---|---|---|---|
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_codesoffers[].codeproduct_id | string | да | Артикул производителяпоставщика (ключ в products). | ||||
manufacturer_codesoffers[].manufacturerquantity | objectinteger | даОписание | компании-производителяКоличество товара доступное для заказа. | ||||
manufacturer_codesoffers[].manufacturer.idprice | stringfloat | да | Идентификатор компании-производителяЦена. | ||||
manufacturer_codesoffers[].manufacturer.namestore | string | да | Наименование компании-производителя. | Ключ описания склада в stores[]. | |||
offersmanufacturer_codes[].medialabels | object | нет | Список медиа-файлов. | ||||
manufacturer_codes[].media.images[] | array | нет | Список изображений товара. | ||||
manufacturer_codes[].media.images[].url | string | да | Ссылка на полноразмерное изображение. | ||||
Метки присвоенные предложению поставщиком. Здесь могут возвращаться например:
| |||||||
stores[] | array | да | Список складов, на которых доступен данный товар. Ключом является идентификатор точки выдачи. | ||||
stores[].address | string | да | Адрес | manufacturer_codes[].media.images[].thumbnail | string | да | Ссылка на миниатюру. |