Микросервис catalog
Микросервис catalog отвечает за управление каталогом товаров и услуг. Он позволяет работать с категориями, товарами, медиа-активами и характеристиками.
Доступ к сервису предоставляется по запросу.
Логика работы
В работе микросервиса участвуют следующие сущности:
- Медиа ассет (Media Asset) - содержит информацию о медиа (id, название, url на соответствующем внешнем ресурсе, описание, теги и др.)
- Категория (Category) - содержит информацию о категории (id, название, url, медиа, характеристики, уровень в иерархии категорий и др.)
- Характеристика (Feature) - содержит информацию о характеристике продукта или варианта продукта (id, название, значения характеристики и др.)
- Продукт (Product) - содержит информацию о продукте (id, название, варианты товара, характеристики, медиа ассеты, категория и др.)
- Каталог (Catalog) - содержит данные о каталоге (id, название и привязанные категории)
Аутентификация
При обращении к сервису аутентификация не нужна.
Service context path
/api/catalog/
Настройки и параметры конфигурации
Параметры конфигурации указываются в Vault.
Vault используется на нашей платформе в качестве хранилища всех конфигураций развертывания. Инструмент может быть выбран другой.
{
"env": {
"JAVA_XMS": "XXm",
"JAVA_XMX": "YYYm",
"SPRING_DATA_MONGODB_DATABASE": "название_бд",
"SPRING_DATA_MONGODB_PORT": "порт_бд",
"SPRING_DATA_MONGODB_USERNAME": "юзернейм_для_бд"
}
}
// пример взят с тестового стенда
{
"env": {
"AUTH_ENABLED": "флаг_активации_аутентификации",
"KAFKA_BROKER_ADDRESS": "сокет_для_брокера_kafka",
"MEDIA_URL": "url_путь_доступа_к_сервису_media",
"OAUTH_ECOM_CLIENT_ID": "токен_приложения_ECOM_OAuth",
"OAUTH_ZITADEL_CLIENT_ID": "токен_приложения_Zitadel",
"OAUTH_ZITADEL_ISSUER_URI": "url_Zitadel",
"SPRING_DATA_MONGODB_HOST": "хост_бд",
"SPRING_DATA_MONGODB_PASSWORD": "пароль_для_бд"
}
}
Методы микросервиса 
Работа с медиа ассетами
- Получение страницы с медиа ассетами - GET запрос, /v1/assets
page - query-параметр: номер страницы
size -
query-параметр: размер страницы
sort - query-параметр: сортировка
страницы
{
"content": [
{
"id":
"64ca6e19de8e08679dd39d4a",
"media": {
"url":
"master/catalog/images/1690988041823-1882559365.png",
"absoluteUrl":
"https://storage.yandexcloud.net/dc-demo-ecom-media-public/master/catalog/images/1690988041823-1882559365.png",
"name":
"1688468451472-1882559365.png",
"type": "PHOTO",
"size": 112136,
"resolution": "427x427 px",
"createdDate": "2023-08-02T17:54:17.86"
},
"title": "Топ",
"altAttr": "Топ",
"description":
"",
"sign": "",
"tags": [
""
]
},
{
"id":
"64ca7635de8e08679dd39d4b",
"media": {
"url":
"master/catalog/images/1690990102611-1882559365.png",
"absoluteUrl":
"https://storage.yandexcloud.net/dc-demo-ecom-media-public/master/catalog/images/1690990102611-1882559365.png",
"name":
"1688467908360-1882559365.png",
"type": "PHOTO",
"size": 87928,
"resolution": "427x427 px",
"createdDate": "2023-08-02T18:28:53.712"
},
"title": "Топ",
"altAttr": "Топ",
"description":
"",
"sign": "",
"tags": [
""
]
},
{
"id":
"64ca7635de8e08679dd39d4c",
"media": {
"url":
"master/catalog/images/1690990102568-1882559365.png",
"absoluteUrl":
"https://storage.yandexcloud.net/dc-demo-ecom-media-public/master/catalog/images/1690990102568-1882559365.png",
"name":
"1688467908334-1882559365.png",
"type": "PHOTO",
"size": 113468,
"resolution": "427x427 px",
"createdDate": "2023-08-02T18:28:53.713"
},
"title": "Топ",
"altAttr": "Топ",
"description":
"",
"sign": "",
"tags": [
""
]
}
],
"pageable": {
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"pageSize": 3,
"pageNumber": 0,
"offset": 0,
"paged": true,
"unpaged": false
},
"last":
false,
"totalPages": 115,
"totalElements": 344,
"first": true,
"numberOfElements": 3,
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"size": 3,
"number": 0,
"empty": false
}
200- операция выполнена успешно, получен список медиа ассетов
- Получение медиа ассета по его ID - GET запрос, /v1/assets/{id}
id - path-параметр, обязательный: уникальный идентификатор медиа
ассета
{
"id":
"26002942-9a8d-44c6-a70d-1486cdc6b872",
"media": {
"url":
"master/catalog/images/1714113158689-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
"name": "krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution": "1805x1128
px",
"createdDate":
"2024-04-26T09:32:45.459"
},
"title": "krasivye-kartinki-kotikov-55",
"altAttr":
"krasivye-kartinki-kotikov-55",
"description":
"кросивое!",
"sign": "test",
"tags": [
""
]
}
- 200 - операция выполнена успешно, получены данные медиа ассета
- 404 - ошибка, медиа ассет не
найден
- Получение списка медиа ассетов - POST запрос, /v1/assets/list
{
"assetIds": [
"26002942-9a8d-44c6-a70d-1486cdc6b872",
"a3b80eaf-0d67-46cf-9e20-101eacc09dc0"
]
}
[
{
"id":
"26002942-9a8d-44c6-a70d-1486cdc6b872",
"media": {
"url":
"master/catalog/images/1714113158689-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
"name":
"krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution":
"1805x1128 px",
"createdDate":
"2024-04-26T09:32:45.459"
},
"title": "krasivye-kartinki-kotikov-55",
"altAttr": "krasivye-kartinki-kotikov-55",
"description": "кросивое",
"sign": "test",
"tags": [
""
]
},
{
"id": "a3b80eaf-0d67-46cf-9e20-101eacc09dc0",
"media": {
"url":
"master/catalog/images/1716309880428-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880428-1882559365.jpg",
"name":
"0ab024374be82f3b0b971a620c0588b5.jpg",
"type": "PHOTO",
"size": 185853,
"resolution":
"960x710 px",
"createdDate":
"2024-05-21T19:44:42.592"
},
"title": "0ab024374be82f3b0b971a620c0588b5",
"altAttr":
"0ab024374be82f3b0b971a620c0588b5",
"description": "",
"sign": "",
"tags": [
""
]
}
]
200 - операция успешно выполнена, получен список медиа ассетов
- Получение списка медиа ассетов (с учетом пагинации, сортировки и фильтров) - POST запрос, /v1/assets/filter
{
"sort": [
{
"sortBy": "media.createdDate",
"direction": "desc"
}
],
"page":
0,
"size": 10,
"filter": {
"searchTerm": "",
"name": {
"value": "kot"
},
"type":
{
"value": "photo"
},
"resolution":
{
"value": ""
},
"size": {
"value": "417"
},
"createdDate": {
"start": "2024-04-26T00:00:00",
"end": ""
}
}
}
{
"content": [
{
"id":
"527e30ce-8891-4049-9b36-265ef179e07e",
"media": {
"url": "master/catalog/images/1714574818873-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
"name":
"krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution": "1805x1128 px",
"createdDate":
"2024-05-01T17:47:08.871"
},
"title":
"krasivye-kartinki-kotikov-5511",
"altAttr": "krasivye-kartinki-kotikov-5511",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id":
"26002942-9a8d-44c6-a70d-1486cdc6b872",
"media": {
"url": "master/catalog/images/1714113158689-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
"name":
"krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution": "1805x1128 px",
"createdDate":
"2024-04-26T09:32:45.459"
},
"title":
"krasivye-kartinki-kotikov-55",
"altAttr": "krasivye-kartinki-kotikov-55",
"description": "кросивое",
"sign": "test",
"tags":
[
""
]
},
{
"id": "64b7fadfb5a7960e96b3105f",
"media": {
"url": "master/catalog/images/1689778904856-1882559365.jpg",
"name":
"1250-666-porodista-kotka.jpg",
"type": "PHOTO",
"size": 78393,
"resolution": "1250x666 px",
"createdDate": "2023-07-19T18:01:51.515"
},
"title": "тест",
"altAttr": "кошка123",
"description": "",
"sign":
"",
"tags": [
""
]
},
{
"id":
"64b15f63460ae8511a0e7255",
"media": {
"url":
"master/catalog/images/1689345881306-1882559365.jpg",
"name": "1250-666-porodista-kotka.jpg",
"type": "PHOTO",
"size": 78393,
"resolution": "1250x666
px",
"createdDate":
"2023-07-14T17:44:51.198"
},
"title": "1",
"altAttr": "1",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"number": 0,
"size": 4,
"totalElements": 4,
"pageable": "INSTANCE",
"last": true,
"totalPages": 1,
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"first": true,
"numberOfElements": 4,
"empty": false
}
200 - операция выполнена успешно, получен отфильтрованный список медиа ассетов
- Обновление медиа ассета - PATCH запрос, /v1/assets/{id}
id - path-параметр, обязательный: уникальный идентификатор медиа
ассета
{
"url":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
"name": "krasivye-kartinki-kotikov-55.jpg",
"resolution": "1805x1128 px",
"size": 427989,
"title":
"krasivye-kartinki-kotikov-55",
"altAttr":
"krasivye-kartinki-kotikov-55",
"description": "кросивое",
"sign":
"test",
"tags": [
""
]
}
{
"id":
"26002942-9a8d-44c6-a70d-1486cdc6b872",
"media": {
"url":
"master/catalog/images/1714113158689-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714113158689-1882559365.jpg",
"name":
"krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution": "1805x1128 px",
"createdDate":
"2024-04-26T09:32:45.459"
},
"title": "krasivye-kartinki-kotikov-55",
"altAttr": "krasivye-kartinki-kotikov-55",
"description": "кросивое",
"sign": "test",
"tags": [
""
]
}
- 200 - операция выполнена успешно, медиа ассет обновлен
- 404 - ошибка, медиа ассет не найден
- Создание медиа ассета - POST запрос, /v1/assets
{
"url":
"master/catalog/images/1714123859727-1882559365.jfif",
"name": "productImage.jfif",
"resolution": "720x720 px",
"extension":
"jpeg",
"size": 28008,
"title": "новаяСумочка",
"altAttr": "newBag",
"description": "Очень
качественная сумка",
"sign": "",
"tags": [
""
]
}
{
"id":
"cf095d70-fe49-4cc2-a8bf-28c4d330ce22",
"media": {
"url":
"master/catalog/images/1714123859727-1882559365.jfif",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714123859727-1882559365.jfif",
"name":
"productImage.jfif",
"type": "PHOTO",
"size": 28008,
"resolution": "720x720 px",
"createdDate": "2024-04-26T12:31:34.15561"
},
"title": "новаяСумочка",
"altAttr": "newBag",
"description": "Очень качественная сумка",
"sign": "",
"tags": [
""
]
}
- 200 - операция выполнена успешно, возвращен список остатков с учетом примененных фильтров
- 422 - ошибка, Unprocessable Entity
- Удаление медиа ассета - DELETE запрос, /v1/assets/{id}
id - path-параметр, обязательный: уникальный идентификатор медиа
ассета
Отсутствует. В ответе приходит только код операции, например, 204.
- 204 - операция выполнена успешно, медиа ассет удален
- 404 - ошибка, медиа ассет не найден
- Добавление медиа ассета к продукту/варианту продукта - PATCH запрос, /async/v1/products/variants/{extProductId}-{extVariantId}/media/{mediaAssetId}
extProductId - path-параметр, обязательный: внешний уникальный
идентификатор продукта
extVariantId - path-параметр, обязательный:
внешний уникальный идентификатор варианта продукта
mediaAssetId -
path-параметр, обязательный: уникальный идентификатор медиа ассета
Отсутствует. В ответе приходит только код операции, например, 204.
-
204 - операция выполнена успешно
Работа с категориями
- Получение страницы с категориями - GET запрос, /v1/categories
page - query-параметр: номер страницы
size -
query-параметр: размер страницы
sort - query-параметр: сортировка
страницы
{
"content": [
{
"id":
"cat1000169DC",
"name": "Разные
товары",
"title": "товары",
"url": "/goods",
"media": {
"id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6",
"media": {
"url":
"master/catalog/images/1716309880511-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880511-1882559365.jpg",
"name":
"ec870917c4083ef399d2fbf9516c9f7b.jpg",
"type": "PHOTO",
"size": 88678,
"resolution":
"700x700 px",
"createdDate": "2024-05-21T19:44:42.592"
},
"title": "ec870917c4083ef399d2fbf9516c9f7b",
"altAttr":
"ec870917c4083ef399d2fbf9516c9f7b",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000045DC",
"name": "Плотность",
"values": [
"",
"1200г/дм3"
],
"createdDate":
"2023-12-04T14:59:33.688"
},
{
"id":
"f1000037DC",
"name": "Максимальная мощность",
"values": [
"",
"600
W"
],
"createdDate":
"2023-12-04T12:54:55.419"
},
{
"id":
"f1000049DC",
"name": "Цвет",
"values": [
"белый титан",
"",
"красный",
"фиолетовый",
"пурпурный",
"темно-коричневый",
"синий",
"черный",
"голубой",
"белый",
"Зеленый",
"розовый",
"серый",
"синий титан",
"зеленый",
"пудровый"
],
"createdDate":
"2023-12-04T16:18:18.7"
},
{
"id":
"f1000080DC",
"name": "Упаковка",
"values": [
"",
"Весовая, кг",
"Бумага",
"Стекло",
"Металл",
"Картон",
"Пластик",
"Пленка",
"Коробка",
"Тара, 5кг"
],
"createdDate": "2023-12-19T11:13:04.866"
},
{
"id": "f1000016DC",
"name": "Состав",
"values": [
"",
"80% хлопок, 20%
полиэстер",
"Металл",
"40% шерсть, 20% акрил, 5% эластан, 30% вискоза, 5%
полиэстер",
"Пластик",
"пр.натуральный нубук;пр.натуральная замша",
"95%
спирт",
"100% полиэстер",
"95% хлопок, 5% эластан"
],
"createdDate":
"2023-12-01T17:49:26.516"
},
{
"id":
"f1000017DC",
"name": "Назначение косметического средства",
"values": [
"",
"Обеспечивает антивозрастной эффект, помогающий замедлить процесс старения,
повысить эластичность, плотность и тонус кожи"
],
"createdDate":
"2023-12-01T17:49:41.247"
},
{
"id":
"f1000109DC",
"name": "Функции камеры",
"values": [
"",
"автофокусировка,
оптическая стабилизация, основная камера, тыловая вспышка, фронтальная
камера"
],
"createdDate": "2024-01-17T14:19:38.424"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 15,
"seo": {
"title":
"Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product%
%name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category%
от %price-min% до %price-max%"
},
"catalogId":
"master-catalog"
},
{
"id":
"cat1000175DC",
"name":
"Лонгсливы",
"title":
"Лонгсливы",
"url":
"/Longsleave",
"media": {
"id":
"8bcf6390-3d21-483a-af3b-f5380c37c266",
"media": {
"url":
"master/catalog/images/1702289989026-1882559365.JPG",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1702289989026-1882559365.JPG",
"name": "Лонгслив
стимпанк.JPG",
"type": "PHOTO",
"size": 34469,
"resolution": "443x592 px",
"createdDate":
"2023-12-11T13:19:58.066"
},
"title":
"Лонгслив стимпанк",
"altAttr": "Лонгслив",
"description": "",
"sign": "",
"tags":
[
""
]
},
"features": [],
"type":
"WITH_PRODUCTS",
"parentCategoryId": null,
"level":
1,
"order": 33,
"seo": null,
"catalogId": "master-catalog"
},
{
"id": "cat1000176DC",
"name": "Куртки мужские",
"title": "Куртки мужские1",
"url": "/Kurtki-muzhskie1",
"media": {
"id": "27295382-98c0-4ec3-b821-16e015412402",
"media": {
"url":
"master/catalog/images/1703510893645-1882559365.JPG",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1703510893645-1882559365.JPG",
"name": "Куртка
мужчина катег.JPG",
"type": "PHOTO",
"size": 136899,
"resolution": "927x832 px",
"createdDate":
"2023-12-25T16:28:31.5"
},
"title": "Куртка
категория",
"altAttr":
"Куртка категория",
"description": "",
"sign": "",
"tags":
[
""
]
},
"features": [
{
"id":
"f1000082DC",
"name": "Рост",
"values": [
"",
"150",
"140",
"130",
"120"
],
"createdDate": "2023-12-20T08:35:22.49"
},
{
"id": "f1000080DC",
"name": "Упаковка",
"values": [
"",
"Весовая, кг",
"Бумага",
"Стекло",
"Металл",
"Картон",
"Пластик",
"Пленка",
"Коробка",
"Тара, 5кг"
],
"createdDate": "2023-12-19T11:13:04.866"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 8,
"seo": {
"title":
"Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product%
%name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category%
от %price-min% до %price-max%"
},
"catalogId":
"master-catalog"
}
],
"pageable": {
"sort": {
"unsorted": true,
"sorted": false,
"empty": true
},
"pageNumber": 0,
"pageSize": 3,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages":
8,
"totalElements": 22,
"last":
false,
"first": true,
"numberOfElements": 3,
"sort": {
"unsorted": true,
"sorted":
false,
"empty": true
},
"size": 3,
"number": 0,
"empty": false
}
200 - операция выполнена успешно, получена страница с категориями
- Получение категории по ее ID - GET запрос, /v1/categories/{id}
id - path-параметр, обязательный: уникальный
идентификатор категории
parents - query-параметр: флаг активации
получения данных родительской категории
{
"id": "cat1001216DC",
"name": "iPhone",
"title":
"iPhone",
"url": "/iPhone",
"media": {
"id":
"527e30ce-8891-4049-9b36-265ef179e07e",
"media": {
"url":
"master/catalog/images/1714574818873-1882559365.jpg",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
"name":
"krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution":
"1805x1128 px",
"createdDate":
"2024-05-01T17:47:08.871"
},
"title": "krasivye-kartinki-kotikov-5511",
"altAttr": "krasivye-kartinki-kotikov-5511",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id":
"f1000105DC",
"name": "Версия ОС
на начало продаж",
"values":
[
"",
" iOS 17"
],
"createdDate": "2024-01-17T14:18:37.961"
},
{
"id": "f1000106DC",
"name": "Тип корпуса",
"values": [
"",
"классический",
"оригинальный"
],
"createdDate": "2024-01-17T14:18:48.452"
},
{
"id": "f1000107DC",
"name": "Дисплей",
"values": [
"",
" 6.1\" (2556x1179), 2K QHD,
OLED",
"7.2"
],
"createdDate": "2024-01-17T14:19:08.695"
},
{
"id": "f1000108DC",
"name": "Особенности экрана",
"values": [
"",
"Dynamic Island,
сенсорный экран, устойчивое к царапинам стекло, цветной экран"
],
"createdDate": "2024-01-17T14:19:21.77"
},
{
"id": "f1000109DC",
"name": "Функции камеры",
"values": [
"",
"автофокусировка,
оптическая стабилизация, основная камера, тыловая вспышка, фронтальная
камера"
],
"createdDate": "2024-01-17T14:19:38.424"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId":
"cat1000209DC",
"level": 2,
"order": 40,
"seo": {
"title": "Глобальный Шаблон title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product%
%name-category%",
"description": "Глобальный
шаблон description %name-product% в %name-category% от %price-min%
до %price-max%"
},
"catalogId":
"master-catalog",
"parentCategory": {
"id": "cat1000209DC",
"name": "Смартфоны",
"title":
"Смартфоны",
"url": "/Smartfony",
"media": {
"id": "df4dc6ea-e0cf-4a1f-b63d-02087348965a",
"media": {
"url": "master/catalog/images/1714124906917-1882559365.jfif",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714124906917-1882559365.jfif",
"name":
"productImage.jfif",
"type": "PHOTO",
"size": 28008,
"resolution": "720x720 px",
"createdDate": "2024-04-26T12:48:33.794"
},
"title":
"productImage",
"altAttr":
"productImage",
"description":
"",
"sign": "",
"tags": [
""
]
},
"features": [],
"type":
"NO_PRODUCTS",
"parentCategoryId":
null,
"level": 1,
"order": 34,
"seo": {
"title": "Свой Шаблон title
%name-category%",
"keywords":
"Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон
description %name-product% в %name-category% от %price-min% до
%price-max%"
},
"catalogId": "master-catalog"
}
}
- 200 - операция выполнена успешно, получены данные категории
- 404 - ошибка, категория не найдена
- Получение отфильтрованного дерева категорий - POST запрос, /v1/categories/tree
{
"searchTerm":
"смартфоны",
"catalogId":
"master-catalog"
}
{
"children":
[
{
"children": [],
"id": "cat1000209DC",
"name": "Смартфоны",
"title": "Смартфоны",
"url": "/Smartfony",
"media": {
"id": "df4dc6ea-e0cf-4a1f-b63d-02087348965a",
"media":
{
"url":
"master/catalog/images/1714124906917-1882559365.jfif",
"absoluteUrl":
"https://test-ecom-media.digitalchief.tech/master/catalog/images/1714124906917-1882559365.jfif",
"name": "productImage.jfif",
"type": "PHOTO",
"size": 28008,
"resolution": "720x720 px",
"createdDate":
"2024-04-26T12:48:33.794"
},
"title": "productImage",
"altAttr": "productImage",
"description":
"",
"sign": "",
"tags":
[
""
]
},
"features": [],
"type": "NO_PRODUCTS",
"level": 1,
"order": 34,
"seo": {
"title": "Свой Шаблон title
%name-category%",
"keywords": "Глобальный Шаблон
keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category%
от %price-min% до %price-max%"
},
"catalogId":
"master-catalog"
}
]
}
200 - операция выполнена успешно, получен отфильтрованный список категорий
- Изменение порядка категорий - PATCH запрос, /v2/categories/change-order
{
"firstCategoryId":
"cat1000175DC",
"secondCategoryId":
"cat1000209DC",
"catalogId": ""
}
Возвращает дерево категорий.
- 200 - операция выполнена успешно, изменен порядок категорий
- 400 - ошибка, категории должны быть одного и того же уровня
- 404 - ошибка, категория не найдена
- Поиск дочерней категории по ее названию - GET запрос, /v1/categories/find-by-name/{name}
name - path-параметр, обязательный: имя дочерней категории
catalogId - query-параметр: ID каталога
[
{
"id": "cat1001216DC",
"name": "iPhone",
"title": "iPhone",
"url": "/iPhone",
"media": {
"id": "527e30ce-8891-4049-9b36-265ef179e07e",
"media": {
"url": "master/catalog/images/1714574818873-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714574818873-1882559365.jpg",
"name": "krasivye-kartinki-kotikov-55.jpg",
"type": "PHOTO",
"size": 427989,
"resolution": "1805x1128 px",
"createdDate": "2024-05-01T17:47:08.871"
},
"title": "krasivye-kartinki-kotikov-5511",
"altAttr": "krasivye-kartinki-kotikov-5511",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000105DC",
"name": "Версия ОС на начало продаж",
"values": [
"",
" iOS 17"
],
"createdDate": "2024-01-17T14:18:37.961"
},
{
"id": "f1000106DC",
"name": "Тип корпуса",
"values": [
"",
"классический",
"оригинальный"
],
"createdDate": "2024-01-17T14:18:48.452"
},
{
"id": "f1000107DC",
"name": "Дисплей",
"values": [
"",
" 6.1\" (2556x1179), 2K QHD, OLED",
"7.2"
],
"createdDate": "2024-01-17T14:19:08.695"
},
{
"id": "f1000108DC",
"name": "Особенности экрана",
"values": [
"",
"Dynamic Island, сенсорный экран, устойчивое к царапинам стекло, цветной экран"
],
"createdDate": "2024-01-17T14:19:21.77"
},
{
"id": "f1000109DC",
"name": "Функции камеры",
"values": [
"",
"автофокусировка, оптическая стабилизация, основная камера, тыловая вспышка, фронтальная камера"
],
"createdDate": "2024-01-17T14:19:38.424"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000209DC",
"level": 2,
"order": 40,
"seo": {
"title": "Глобальный Шаблон title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
}
]
- 200 - операция выполнена успешно, возвращена категория с соответствующим именем
- 404 - ошибка, категория с таким именем не найдена
- Поиск родительской категории по ее названию - GET запрос, /v1/categories/find-parent-by-name/{name}
name - path-параметр, обязательный: имя родительской категории
[
{
"id": "cat1000209DC",
"name": "Смартфоны",
"title": "Смартфоны",
"url": "/Smartfony",
"media": {
"id": "df4dc6ea-e0cf-4a1f-b63d-02087348965a",
"media": {
"url": "master/catalog/images/1714124906917-1882559365.jfif",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1714124906917-1882559365.jfif",
"name": "productImage.jfif",
"type": "PHOTO",
"size": 28008,
"resolution": "720x720 px",
"createdDate": "2024-04-26T12:48:33.794"
},
"title": "productImage",
"altAttr": "productImage",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [],
"type": "NO_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 34,
"seo": {
"title": "Свой Шаблон title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
}
]
- 200 - операция выполнена успешно, возвращена категория с соответствующим именем
- 404 - ошибка, категория с таким именем не найдена
- Создание категории - POST запрос, /v2/categories
{
"name": "Для подростков",
"url": "/Dlya-podrostkov",
"parentCategoryId": "cat1000224DC",
"mediaAssetId": "",
"type": "WITH_PRODUCTS",
"seo": {
"title": "",
"keywords": "",
"description": ""
},
"catalogId": "",
"featureIds": [
"f1000005DC"
]
}
{
"id": "cat1007770DC",
"name": "Для подростков",
"title": "Для подростков",
"url": "/Dlya-podrostkov",
"media": null,
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000224DC",
"features": [
{
"id": "f1000005DC",
"name": "Страна производства",
"values": [
"",
"Россия",
"Малайзия",
"Узбекистан",
"Канада",
"Беларусь",
"Китай",
"Турция",
"Индия",
"Япония",
"Бразилия"
]
}
],
"level": 2,
"order": 44,
"seo": {
"title": "",
"keywords": "",
"description": ""
},
"catalogId": ""
}
200 - операция успешно выполнена, категория создана
- Обновление категории - PATCH запрос, /v2/categories/{id}
id - path-параметр, обязательный: идентификатор категории
{
"name": "Для малышей"
}
{
"id": "cat1007770DC",
"name": "Для малышей",
"title": "Для малышей",
"url": null,
"media": null,
"type": null,
"parentCategoryId": "cat1000224DC",
"features": [],
"level": 2,
"order": 44,
"seo": {
"title": "",
"keywords": "",
"description": ""
},
"catalogId": ""
}
- 200 - операция выполнена успешно, медиа ассет обновлен
- 404 - ошибка, медиа ассет не найден
- Удаление категории - DELETE запрос, /v1/categories/{id}
id - path-параметр, обязательный: идентификатор категории
Отсутствует. В ответе приходит только код операции, например, 204.
- 204 - операция выполнена успешно, категория удалена
- 404 - ошибка, не удалось найти категорию
- Загрузка списка категорий - PUT запрос, /v1/categories/list
[
{
"id": "cat1000169DC",
"name": "Разные товары",
"title": "товары",
"url": "/goods",
"media": {
"id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6",
"media": {
"url": "master/catalog/images/1716309880511-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880511-1882559365.jpg",
"name": "ec870917c4083ef399d2fbf9516c9f7b.jpg",
"type": "PHOTO",
"size": 88678,
"resolution": "700x700 px",
"createdDate": "2024-05-21T19:44:42.592"
},
"title": "ec870917c4083ef399d2fbf9516c9f7b",
"altAttr": "ec870917c4083ef399d2fbf9516c9f7b",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000045DC",
"name": "Плотность",
"values": [
"",
"1200г/дм3"
],
"createdDate": "2023-12-04T14:59:33.688"
},
{
"id": "f1000037DC",
"name": "Максимальная мощность",
"values": [
"",
"600 W"
],
"createdDate": "2023-12-04T12:54:55.419"
},
{
"id": "f1000049DC",
"name": "Цвет",
"values": [
"белый титан",
"",
"красный",
"фиолетовый",
"пурпурный",
"темно-коричневый",
"синий",
"черный",
"голубой",
"белый",
"Зеленый",
"розовый",
"серый",
"синий титан",
"зеленый",
"пудровый"
],
"createdDate": "2023-12-04T16:18:18.7"
},
{
"id": "f1000080DC",
"name": "Упаковка",
"values": [
"",
"Весовая, кг",
"Бумага",
"Стекло",
"Металл",
"Картон",
"Пластик",
"Пленка",
"Коробка",
"Тара, 5кг"
],
"createdDate": "2023-12-19T11:13:04.866"
},
{
"id": "f1000016DC",
"name": "Состав",
"values": [
"",
"80% хлопок, 20% полиэстер",
"Металл",
"40% шерсть, 20% акрил, 5% эластан, 30% вискоза, 5% полиэстер",
"Пластик",
"пр.натуральный нубук;пр.натуральная замша",
"95% спирт",
"100% полиэстер",
"95% хлопок, 5% эластан"
],
"createdDate": "2023-12-01T17:49:26.516"
},
{
"id": "f1000017DC",
"name": "Назначение косметического средства",
"values": [
"",
"Обеспечивает антивозрастной эффект, помогающий замедлить процесс старения, повысить эластичность, плотность и тонус кожи"
],
"createdDate": "2023-12-01T17:49:41.247"
},
{
"id": "f1000109DC",
"name": "Функции камеры",
"values": [
"",
"автофокусировка, оптическая стабилизация, основная камера, тыловая вспышка, фронтальная камера"
],
"createdDate": "2024-01-17T14:19:38.424"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 15,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
{
"id": "cat1000175DC",
"name": "Лонгсливы",
"title": "Лонгсливы",
"url": "/Longsleave",
"media": {
"id": "8bcf6390-3d21-483a-af3b-f5380c37c266",
"media": {
"url": "master/catalog/images/1702289989026-1882559365.JPG",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1702289989026-1882559365.JPG",
"name": "Лонгслив стимпанк.JPG",
"type": "PHOTO",
"size": 34469,
"resolution": "443x592 px",
"createdDate": "2023-12-11T13:19:58.066"
},
"title": "Лонгслив стимпанк",
"altAttr": "Лонгслив",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 33,
"seo": null,
"catalogId": "master-catalog"
}
]
{
"created": 2,
"updated": 0
}
200 - операция выполнена успешно, список категорий загружен
Работа с характеристиками
- Загрузка списка характеристик - PUT запрос, /v1/features/list
[
{
"id": "f1000462DC",
"name": "Цвета",
"values": [
"зеленый",
"желтый"
],
"createdDate": "2024-05-24T09:59:55.116Z"
}
]
{
"created": 1,
"updated": 0
}
200 - операция выполнена успешно, загружен список характеристик
- Создание характеристики - POST запрос, /v2/features
Отсутствуют.
{
"name": "Сезон",
"key": "111",
"type": "TEXT",
"filtering": true,
"multiValue": false
}
{
"id": "f1022878DC",
"name": "Сезон",
"key": "111",
"type": "TEXT",
"filtering": true,
"multiValue": false,
"values": [],
"measurements": null,
"createdDate": null,
"referenceType": null
}
- 200 - операция выполнена успешно, характеристика создана
- 409 - ошибка, характеристика с таким именем уже существует
- Получение списка значений характеристики - GET запрос, /v1/features/{id}/values/filter
id - path-параметр,обязательный: уникальный идентификатор характеристики
term - query-параметр: значение характеристики для поиска
[
"12",
"45"
]
- 200 - операция выполнена успешно, получен список значений характеристики
- 404 - ошибка, характеристика не найдена
- Получение страницы с характеристиками - POST запрос, /v1/features/page
Отсутствуют.
{
"sort": [
{
"sortBy": "type",
"direction": "DESC"
}
],
"page": 0,
"size": 2
}
{
"content":[
{
"id":"f1000004DC",
"name":"Рост модели",
"key":null,
"type":"TEXT",
"filtering":true,
"multiValue":false,
"values":[
"67",
"170см",
"175",
"string",
"Green"
],
"measurements":null,
"createdDate":"2024-09-18T15:50:24.906",
"referenceType":null
},
{
"id":"f1000005DC",
"name":"Страна производства",
"key":null,
"type":"TEXT",
"filtering":true,
"multiValue":false,
"values":[
null,
"Россия",
"Малайзия",
"Узбекистан",
"Канада",
"Беларусь",
"Китай",
"Турция",
"Индия",
"Япония",
"Бразилия",
"string",
"Green",
""
],
"measurements":null,
"createdDate":"2024-09-18T15:50:24.906",
"referenceType":null
}
],
"pageable":{
"sort":{
"unsorted":false,
"sorted":true,
"empty":false
},
"pageNumber":0,
"pageSize":2,
"offset":0,
"paged":true,
"unpaged":false
},
"totalPages":50,
"totalElements":150,
"last":false,
"numberOfElements":2,
"first":true,
"sort":{
"unsorted":false,
"sorted":true,
"empty":false
},
"size":2,
"number":0,
"empty":false
}
200 - операция успешно выполнена, получена страница с характеристиками
- Редактирование характеристики - PATCH запрос, /v2/features/{id}
id - path-параметр,обязательный: уникальный идентификатор характеристики
{
"name": "Производитель",
"key": "1111"
}
{
"id": "f1022878DC",
"name": "Производитель",
"key": "1111",
"type": "TEXT",
"filtering": true,
"multiValue": false,
"values": [],
"measurements": null,
"createdDate": "2024-10-03T15:51:52.567",
"referenceType": null
}
- 200 - операция выполнена успешно, характеристика обновлена
- 404 - ошибка, характеристика с таким ID не найдена
- 409 - ошибка, конфликт
- Удаление характеристики - DELETE запрос, /v1/features/{id}
id - path-параметр,обязательный: уникальный идентификатор характеристики
Отсутствует. В ответе приходит только код операции, например, 204.
- 204 - операция выполнена успешно, характеристика удалена
- 404 - ошибка, характеристика не найдена
- Получение списка характеристик - POST запрос, /v1/features/list
{
"searchTerm": "сезон"
}
[
{
"id": "f1000116DC",
"name": "Сезон",
"values": [
"",
"Осень - зима",
"Лето"
],
"createdDate": "2024-02-13T13:56:56.82"
}
]
200 - операция успешно выполнена, получен список характеристик
- Получение характеристики по ее ID - GET запрос, /v1/features/{id}
id - path-параметр, обязательный: уникальный идентификатор характеристики
{
"id": "f1000016DC",
"name": "Состав",
"type": "TEXT",
"filtering": true,
"multiValue": false,
"values": [
null,
"",
"80% хлопок, 20% полиэстер",
"Металл",
"40% шерсть, 20% акрил, 5% эластан, 30% вискоза, 5% полиэстер",
"Пластик",
"пр.натуральный нубук;пр.натуральная замша",
"95% спирт",
"100% полиэстер",
"95% хлопок, 5% эластан"
],
"createdDate": "2024-09-18T15:50:24.906"
}
- 200 - операция выполнена успешно, получены данные характеристики
- 404 - ошибка, характеристика с таким id не найден
- Получение единиц измерения характеристики - GET запрос, /v1/features/measurements/list
term - query-параметр: название единицы измерения
[
"mm",
"Mm",
"sm",
"Dm"
]
200 - операция выполнена успешно, получены единицы измерения
Работа с каталогами
- Получение каталога по его ID - GET запрос, /v2/catalogs/{id}
id - path-параметр, обязательный: ID каталога
{
"id": "c1000099DC",
"name": "catalog_Беларусь",
"categoryIds": [
"cat1007760DC"
]
}
- 200 - операция успешно выполнена, получены данные каталога
- 404 - ошибка, каталог с таким ID не найден
- Создание нового каталога - POST запрос, /v2/catalogs
{
"name": "Рынок Узбекистан",
"categoryIds": [
"cat1007760DC"
]
}
{
"id": "c1000022DC",
"name": "Рынок Узбекистан",
"categoryIds": [
"cat1007760DC"
]
}
200 - операция успешно выполнена, каталог создан
- Редактирование каталога - PATCH запрос, /v2/catalogs/{id}
id - path-параметр, обязательный: ID каталога
{
"name": "Рынок Казахстан"
}
{
"id": "c1000022DC",
"name": "Рынок Казахстан",
"categoryIds": [
"cat1007760DC"
]
}
200 - операция выполнена успешно, каталог обновлен
- Удаление каталога - DELETE запрос, /v2/catalogs/{id}
id - path-параметр, обязательный: ID каталога
В ответе приходит только код операции, например, 404.
- 200 - операция успешно выполнена, каталог удален
- 404 - ошибка, каталог с таким ID не найден
Работа с товарами
- Получение страницы с товарами (с возможностью поиска и фильтрации) - POST запрос, /v1/products/page
{
"sort": [
{
"sortBy": "id",
"direction": "ASC"
}
],
"page": 0,
"size": 3,
"filter": {
"searchTerm": "шорты"
}
}
{
"content": [
{
"id": "1001682DC",
"externalId": null,
"name": "Шорты женские",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "",
"assets": [
{
"id": "f33adc90-ce9c-45ba-ae16-cfa998808dc9",
"media": {
"url": "master/catalog/images/1707916795372-1882559365.jpeg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707916795372-1882559365.jpeg",
"name": "1690990851840-1882559365.jpeg",
"type": "PHOTO",
"size": 72141,
"resolution": "900x1200 px",
"createdDate": "2024-02-14T16:20:04.157"
},
"title": "1690990851840-1882559365",
"altAttr": "1690990851840-1882559365",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": ""
},
{
"featureId": "f1000117DC",
"name": "Вид застежки",
"indexable": true,
"value": ""
},
{
"featureId": "f1000093DC",
"name": "Бренд",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000225DC",
"name": "Для женщин",
"title": "Для женщин",
"url": "/Dlya-zhenshchin",
"media": null,
"features": [
{
"id": "f1000116DC",
"name": "Сезон",
"values": [
"",
"Осень - зима",
"Лето"
],
"createdDate": "2024-02-13T13:56:56.82"
},
{
"id": "f1000117DC",
"name": "Вид застежки",
"values": [
"",
"На молнии",
"пуговка"
],
"createdDate": "2024-02-13T13:57:50.053"
},
{
"id": "f1000093DC",
"name": "Бренд",
"values": [
"",
"FarmStay"
],
"createdDate": "2024-01-17T11:10:02.337"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000224DC",
"level": 2,
"order": 37,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 300,
"catalogId": null,
"variants": [
{
"id": "1001683DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1001682DC",
"name": "Шорты женские",
"description": "",
"assets": [
{
"id": "650992ee52313c36d21a9e35",
"media": {
"url": "master/catalog/images/1695126242399-1882559365.JPG",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1695126242399-1882559365.JPG",
"name": "Шорты женские.JPG",
"type": "PHOTO",
"size": 50183,
"resolution": "795x810 px",
"createdDate": "2023-09-19T15:24:14.387"
},
"title": "Шорты женские",
"altAttr": "шорты",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": "Лето"
}
],
"status": 300
}
]
},
{
"id": "1009006DC",
"externalId": null,
"name": "Шорты светлые",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые! Отличный вариант для летнего отдыха.",
"assets": [
{
"id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
"media": {
"url": "master/catalog/images/1713437908714-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
"name": "photo_2024-01-10_19-20-00.jpg",
"type": "PHOTO",
"size": 134254,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.589"
},
"title": "photo_2024-01-10_19-20-00",
"altAttr": "photo_2024-01-10_19-20-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a070203e-2420-4944-ba49-fea4423b26dd",
"media": {
"url": "master/catalog/images/1713437908807-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
"name": "photo_2024-01-10_19-26-11.jpg",
"type": "PHOTO",
"size": 207702,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.585"
},
"title": "photo_2024-01-10_19-26-11",
"altAttr": "photo_2024-01-10_19-26-11",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [],
"category": {
"id": "cat1000225DC",
"name": "Для женщин",
"title": "Для женщин",
"url": "/Dlya-zhenshchin",
"media": null,
"features": [
{
"id": "f1000116DC",
"name": "Сезон",
"values": [
"",
"Осень - зима",
"Лето"
],
"createdDate": "2024-02-13T13:56:56.82"
},
{
"id": "f1000117DC",
"name": "Вид застежки",
"values": [
"",
"На молнии",
"пуговка"
],
"createdDate": "2024-02-13T13:57:50.053"
},
{
"id": "f1000093DC",
"name": "Бренд",
"values": [
"",
"FarmStay"
],
"createdDate": "2024-01-17T11:10:02.337"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000224DC",
"level": 2,
"order": 37,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 300,
"catalogId": null,
"variants": [
{
"id": "1009007DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1009006DC",
"name": "123",
"description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые!",
"assets": [
{
"id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
"media": {
"url": "master/catalog/images/1713437908714-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
"name": "photo_2024-01-10_19-20-00.jpg",
"type": "PHOTO",
"size": 134254,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.589"
},
"title": "photo_2024-01-10_19-20-00",
"altAttr": "photo_2024-01-10_19-20-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a070203e-2420-4944-ba49-fea4423b26dd",
"media": {
"url": "master/catalog/images/1713437908807-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
"name": "photo_2024-01-10_19-26-11.jpg",
"type": "PHOTO",
"size": 207702,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.585"
},
"title": "photo_2024-01-10_19-26-11",
"altAttr": "photo_2024-01-10_19-26-11",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": "95% хлопок, 5% эластан"
}
],
"status": 400
},
{
"id": "1009008DC",
"externalId": null,
"barcode": "",
"nomenclature": "",
"productId": "1009006DC",
"name": "Шорты светлые",
"description": "Отличные шорты для весенне-летней погоды. Выполнены из натурального хлопка очень легкие и невесомые! Отличный вариант для летнего отдыха.",
"assets": [
{
"id": "da1a24b8-32af-4a66-bbdc-188127cebb41",
"media": {
"url": "master/catalog/images/1713437908714-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908714-1882559365.jpg",
"name": "photo_2024-01-10_19-20-00.jpg",
"type": "PHOTO",
"size": 134254,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.589"
},
"title": "photo_2024-01-10_19-20-00",
"altAttr": "photo_2024-01-10_19-20-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a070203e-2420-4944-ba49-fea4423b26dd",
"media": {
"url": "master/catalog/images/1713437908807-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908807-1882559365.jpg",
"name": "photo_2024-01-10_19-26-11.jpg",
"type": "PHOTO",
"size": 207702,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.585"
},
"title": "photo_2024-01-10_19-26-11",
"altAttr": "photo_2024-01-10_19-26-11",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": "80% хлопок, 20% полиэстер"
}
],
"status": 300
}
]
},
{
"id": "1009009DC",
"externalId": null,
"name": "Шорты женские летние",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "111",
"assets": [
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000045DC",
"name": "Плотность",
"indexable": true,
"value": ""
},
{
"featureId": "f1000037DC",
"name": "Максимальная мощность",
"indexable": true,
"value": ""
},
{
"featureId": "f1000049DC",
"name": "Цвет",
"indexable": true,
"value": ""
},
{
"featureId": "f1000080DC",
"name": "Упаковка",
"indexable": true,
"value": ""
},
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": ""
},
{
"featureId": "f1000017DC",
"name": "Назначение косметического средства",
"indexable": true,
"value": ""
},
{
"featureId": "f1000109DC",
"name": "Функции камеры",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000169DC",
"name": "Разные товары",
"title": "товары",
"url": "/goods",
"media": {
"id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6",
"media": {
"url": "master/catalog/images/1716309880511-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880511-1882559365.jpg",
"name": "ec870917c4083ef399d2fbf9516c9f7b.jpg",
"type": "PHOTO",
"size": 88678,
"resolution": "700x700 px",
"createdDate": "2024-05-21T19:44:42.592"
},
"title": "ec870917c4083ef399d2fbf9516c9f7b",
"altAttr": "ec870917c4083ef399d2fbf9516c9f7b",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000045DC",
"name": "Плотность",
"values": [
"",
"1200г/дм3"
],
"createdDate": "2023-12-04T14:59:33.688"
},
{
"id": "f1000037DC",
"name": "Максимальная мощность",
"values": [
"",
"600 W"
],
"createdDate": "2023-12-04T12:54:55.419"
},
{
"id": "f1000049DC",
"name": "Цвет",
"values": [
"белый титан",
"",
"красный",
"фиолетовый",
"пурпурный",
"темно-коричневый",
"синий",
"черный",
"голубой",
"белый",
"Зеленый",
"розовый",
"серый",
"синий титан",
"зеленый",
"пудровый"
],
"createdDate": "2023-12-04T16:18:18.7"
},
{
"id": "f1000080DC",
"name": "Упаковка",
"values": [
"",
"Весовая, кг",
"Бумага",
"Стекло",
"Металл",
"Картон",
"Пластик",
"Пленка",
"Коробка",
"Тара, 5кг"
],
"createdDate": "2023-12-19T11:13:04.866"
},
{
"id": "f1000016DC",
"name": "Состав",
"values": [
"",
"80% хлопок, 20% полиэстер",
"Металл",
"40% шерсть, 20% акрил, 5% эластан, 30% вискоза, 5% полиэстер",
"Пластик",
"пр.натуральный нубук;пр.натуральная замша",
"95% спирт",
"100% полиэстер",
"95% хлопок, 5% эластан"
],
"createdDate": "2023-12-01T17:49:26.516"
},
{
"id": "f1000017DC",
"name": "Назначение косметического средства",
"values": [
"",
"Обеспечивает антивозрастной эффект, помогающий замедлить процесс старения, повысить эластичность, плотность и тонус кожи"
],
"createdDate": "2023-12-01T17:49:41.247"
},
{
"id": "f1000109DC",
"name": "Функции камеры",
"values": [
"",
"автофокусировка, оптическая стабилизация, основная камера, тыловая вспышка, фронтальная камера"
],
"createdDate": "2024-01-17T14:19:38.424"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 15,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 200,
"catalogId": null,
"variants": [
{
"id": "1009010DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1009009DC",
"name": "Шорты женские летние1",
"description": "",
"assets": [
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": "95% хлопок, 5% эластан"
}
],
"status": 200
},
{
"id": "1009013DC",
"externalId": null,
"barcode": "",
"nomenclature": "",
"productId": "1009009DC",
"name": "Шорты женские летние",
"description": "123",
"assets": [
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": "100% полиэстер"
}
],
"status": 200
},
{
"id": "1009015DC",
"externalId": null,
"barcode": "",
"nomenclature": "",
"productId": "1009009DC",
"name": "Шорты женские летние2",
"description": "<b> укеук </b>\n<p>\n<i> укеук </i>",
"assets": [
{
"id": "66ddb53c-441d-4061-9da8-6aa701aa977e",
"media": {
"url": "master/catalog/images/1713437908626-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908626-1882559365.jpg",
"name": "photo_2024-01-10_19-17-48.jpg",
"type": "PHOTO",
"size": 105995,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.586"
},
"title": "photo_2024-01-10_19-17-48",
"altAttr": "photo_2024-01-10_19-17-48",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "a34cf313-3058-48ff-9109-faa07416e74c",
"media": {
"url": "master/catalog/images/1713437908760-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713437908760-1882559365.jpg",
"name": "photo_2024-01-10_19-26-00.jpg",
"type": "PHOTO",
"size": 228232,
"resolution": "900x1200 px",
"createdDate": "2024-04-18T13:58:30.587"
},
"title": "photo_2024-01-10_19-26-00",
"altAttr": "photo_2024-01-10_19-26-00",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000016DC",
"name": "Состав",
"indexable": true,
"value": "80% хлопок, 20% полиэстер"
}
],
"status": 200
}
]
}
],
"pageable": {
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"pageNumber": 0,
"pageSize": 3,
"offset": 0,
"paged": true,
"unpaged": false
},
"last": false,
"totalPages": 2,
"totalElements": 4,
"first": true,
"numberOfElements": 3,
"sort": {
"unsorted": false,
"sorted": true,
"empty": false
},
"size": 3,
"number": 0,
"empty": false
}
200 - операция выполнена успешно, получена страница с товарами
- Получение списка товаров - POST запрос, /v1/products/list
{
"searchTerm": "шорты женские хлопковые"
}
[
{
"id": "1014217DC",
"externalId": null,
"name": "Шорты женские хлопковые",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "111",
"assets": [
{
"id": "3869f4d9-8eea-4824-982b-feff73992467",
"media": {
"url": "master/catalog/images/1707741018989-1882559365.jpeg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707741018989-1882559365.jpeg",
"name": "1690990851840-1882559365.jpeg",
"type": "PHOTO",
"size": 72141,
"resolution": "900x1200 px",
"createdDate": "2024-02-12T15:30:41.965"
},
"title": "1690990851840-1882559365",
"altAttr": "1690990851840-1882559365",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6",
"media": {
"url": "master/catalog/images/1716309880511-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880511-1882559365.jpg",
"name": "ec870917c4083ef399d2fbf9516c9f7b.jpg",
"type": "PHOTO",
"size": 88678,
"resolution": "700x700 px",
"createdDate": "2024-05-21T19:44:42.592"
},
"title": "ec870917c4083ef399d2fbf9516c9f7b",
"altAttr": "ec870917c4083ef399d2fbf9516c9f7b",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": ""
},
{
"featureId": "f1000117DC",
"name": "Вид застежки",
"indexable": true,
"value": ""
},
{
"featureId": "f1000093DC",
"name": "Бренд",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000225DC",
"name": "Для женщин",
"title": "Для женщин",
"url": "/Dlya-zhenshchin",
"media": null,
"features": [
{
"id": "f1000116DC",
"name": "Сезон",
"values": [
"",
"Осень - зима",
"Лето"
],
"createdDate": "2024-02-13T13:56:56.82"
},
{
"id": "f1000117DC",
"name": "Вид застежки",
"values": [
"",
"На молнии",
"пуговка"
],
"createdDate": "2024-02-13T13:57:50.053"
},
{
"id": "f1000093DC",
"name": "Бренд",
"values": [
"",
"FarmStay"
],
"createdDate": "2024-01-17T11:10:02.337"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000224DC",
"level": 2,
"order": 37,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 300,
"variants": [
{
"id": "1014218DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1014217DC",
"name": "Шорты женские хлопковые",
"description": "",
"assets": [
{
"id": "3869f4d9-8eea-4824-982b-feff73992467",
"media": {
"url": "master/catalog/images/1707741018989-1882559365.jpeg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707741018989-1882559365.jpeg",
"name": "1690990851840-1882559365.jpeg",
"type": "PHOTO",
"size": 72141,
"resolution": "900x1200 px",
"createdDate": "2024-02-12T15:30:41.965"
},
"title": "1690990851840-1882559365",
"altAttr": "1690990851840-1882559365",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": "Лето"
}
],
"status": 300
}
]
}
]
200 - операция выполнена успешно, получен список товаров
- Получение продукта по его ID - GET запрос, /v2/products/{id}
id - path-параметр, обязательный:ID продукта
isAvailable - query-параметр: флаг наличия продукта на складе
{
"id": "1014217DC",
"externalId": null,
"name": "Шорты женские хлопковые",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "111",
"assets": [
{
"id": "3869f4d9-8eea-4824-982b-feff73992467",
"media": {
"url": "master/catalog/images/1707741018989-1882559365.jpeg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707741018989-1882559365.jpeg",
"name": "1690990851840-1882559365.jpeg",
"type": "PHOTO",
"size": 72141,
"resolution": "900x1200 px",
"createdDate": "2024-02-12T15:30:41.965"
},
"title": "1690990851840-1882559365",
"altAttr": "1690990851840-1882559365",
"description": "",
"sign": "",
"tags": [
""
]
},
{
"id": "d791baa2-d32b-4d7d-a5e9-94c4ad1e83e6",
"media": {
"url": "master/catalog/images/1716309880511-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1716309880511-1882559365.jpg",
"name": "ec870917c4083ef399d2fbf9516c9f7b.jpg",
"type": "PHOTO",
"size": 88678,
"resolution": "700x700 px",
"createdDate": "2024-05-21T19:44:42.592"
},
"title": "ec870917c4083ef399d2fbf9516c9f7b",
"altAttr": "ec870917c4083ef399d2fbf9516c9f7b",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": ""
},
{
"featureId": "f1000117DC",
"name": "Вид застежки",
"indexable": true,
"value": ""
},
{
"featureId": "f1000093DC",
"name": "Бренд",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000225DC",
"name": "Для женщин",
"title": "Для женщин",
"url": "/Dlya-zhenshchin",
"media": null,
"features": [
{
"id": "f1000116DC",
"name": "Сезон",
"values": [
"",
"Осень - зима",
"Лето"
],
"createdDate": "2024-02-13T13:56:56.82"
},
{
"id": "f1000117DC",
"name": "Вид застежки",
"values": [
"",
"На молнии",
"пуговка"
],
"createdDate": "2024-02-13T13:57:50.053"
},
{
"id": "f1000093DC",
"name": "Бренд",
"values": [
"",
"FarmStay"
],
"createdDate": "2024-01-17T11:10:02.337"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": "cat1000224DC",
"level": 2,
"order": 37,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 300,
"variants": [
{
"id": "1014218DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1014217DC",
"name": "Шорты женские хлопковые",
"description": "",
"assets": [
{
"id": "3869f4d9-8eea-4824-982b-feff73992467",
"media": {
"url": "master/catalog/images/1707741018989-1882559365.jpeg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1707741018989-1882559365.jpeg",
"name": "1690990851840-1882559365.jpeg",
"type": "PHOTO",
"size": 72141,
"resolution": "900x1200 px",
"createdDate": "2024-02-12T15:30:41.965"
},
"title": "1690990851840-1882559365",
"altAttr": "1690990851840-1882559365",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "f1000116DC",
"name": "Сезон",
"indexable": true,
"value": "Лето"
}
],
"status": 300
}
]
}
- 200 - операция выполнена успешно, получены данные товара
- 404 - ошибка, товар с таким ID не найден
- Создание товара - POST запрос, /v2/products
{
"name": "Спортивная футболка",
"description": "Классная футболка для спорта.",
"assets": [
{
"id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989"
}
],
"category": {
"id": "cat1000224DC"
},
"status": 100,
"variants": [
{
"mediaAssetIds": [
"bda4c2a4-6683-43e6-bc53-feb8e1bf0989"
],
"attributes": [],
"status": 100
}
],
"features": [
{
"featureId": "f1000005DC",
"name": "Страна производства",
"indexable": true,
"value": ""
}
],
"seo": {
"title": "",
"keywords": "",
"description": ""
}
}
{
"id": "1019684DC",
"externalId": null,
"name": "Спортивная футболка для женщин",
"seo": {
"title": "",
"keywords": "",
"description": ""
},
"description": "Классная футболка для спорта.",
"assets": [
{
"id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989",
"media": {
"url": "master/catalog/images/1706533175315-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706533175315-1882559365.jpg",
"name": "photo_2024-01-10_23-35-20.jpg",
"type": "PHOTO",
"size": 132516,
"resolution": "900x1200 px",
"createdDate": "2024-01-29T15:59:43.168"
},
"title": "photo_2024-01-10_23-35-20",
"altAttr": "photo_2024-01-10_23-35-20",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000005DC",
"name": "Страна производства",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000224DC",
"name": "Одежда универсальная",
"title": "Одежда универсальная",
"url": "/Odezhda-universalnaya",
"media": {
"id": "02e62a7a-9c76-4cb2-9156-19ee57047ced",
"media": {
"url": "master/catalog/images/1713788986747-1882559365.png",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713788986747-1882559365.png",
"name": "костюм 2.png",
"type": "PHOTO",
"size": 1013408,
"resolution": "900x1200 px",
"createdDate": "2024-04-22T15:29:48.78"
},
"title": "костюм 2",
"altAttr": "костюм 2",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000005DC",
"name": "Страна производства",
"values": [
"",
"Россия",
"Малайзия",
"Узбекистан",
"Канада",
"Беларусь",
"Китай",
"Турция",
"Индия",
"Япония",
"Бразилия"
],
"createdDate": "2023-11-30T14:25:26.884"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 76,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 100,
"catalogId": "master-catalog",
"variants": [
{
"id": "1019685DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1019684DC",
"name": "Спортивная футболка для женщин",
"description": "Классная футболка для спорта.",
"assets": null,
"attributes": [],
"status": 100
}
]
}
200 - операция выполнена успешно, товар создан
- Редактирование отфильтрованных товаров - PATCH запрос, /v2/products
{
"filter": {//критерии, по которым отфильтровываются товары для редактирования
},
"body": {//изменения, для внесения в отфильтрованные товары
}
}
Отсутствует.
- 202 - операция успешно выполнена, товары обновлены
- 400 - ошибка, товары в таких статусах не могут быть обновлены
- Редактирование товара - PATCH запрос, /v2/products/{id}
id - path-параметр, обязательный: уникальный идентификатор товара
{
"id": "1019682DC",
"name": "Спортивная футболка",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "Классная футболка для занятий спортом для женщин.",
"assets": [
{
"id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989",
"media": {
"url": "master/catalog/images/1706533175315-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706533175315-1882559365.jpg",
"name": "photo_2024-01-10_23-35-20.jpg",
"type": "PHOTO",
"size": 132516,
"resolution": "900x1200 px",
"createdDate": "2024-01-29T15:59:43.168"
},
"title": "photo_2024-01-10_23-35-20",
"altAttr": "photo_2024-01-10_23-35-20",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000005DC",
"name": "Страна производства",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000224DC",
"name": "Одежда универсальная",
"title": "Одежда универсальная",
"url": "/Odezhda-universalnaya",
"media": {
"id": "02e62a7a-9c76-4cb2-9156-19ee57047ced",
"media": {
"url": "master/catalog/images/1713788986747-1882559365.png",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713788986747-1882559365.png",
"name": "костюм 2.png",
"type": "PHOTO",
"size": 1013408,
"resolution": "900x1200 px",
"createdDate": "2024-04-22T15:29:48.78"
},
"title": "костюм 2",
"altAttr": "костюм 2",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000005DC",
"name": "Страна производства",
"values": [
"",
"Россия",
"Малайзия",
"Узбекистан",
"Канада",
"Беларусь",
"Китай",
"Турция",
"Индия",
"Япония",
"Бразилия"
],
"createdDate": "2023-11-30T14:25:26.884"
}
],
"type": "WITH_PRODUCTS",
"level": 1,
"order": 76,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 100,
"catalogId": "master-catalog",
"variants": [
{
"id": "1019683DC",
"productId": "1019682DC",
"name": "Спортивная футболка",
"description": "Классная футболка для спорта.",
"assets": [],
"attributes": [],
"status": 100,
"orderable": false
}
]
}
{
"id": "1019682DC",
"externalId": null,
"name": "Спортивная футболка",
"seo": {
"title": "%name-product% ",
"keywords": "глобальный шаблон keywords %name-product% ",
"description": "глобальный шаблон %name-product% в %name-category% от %price-min% до %price-max%"
},
"description": "Классная футболка для занятий спортом для женщин.",
"assets": [
{
"id": "bda4c2a4-6683-43e6-bc53-feb8e1bf0989",
"media": {
"url": "master/catalog/images/1706533175315-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706533175315-1882559365.jpg",
"name": "photo_2024-01-10_23-35-20.jpg",
"type": "PHOTO",
"size": 132516,
"resolution": "900x1200 px",
"createdDate": "2024-01-29T15:59:43.168"
},
"title": "photo_2024-01-10_23-35-20",
"altAttr": "photo_2024-01-10_23-35-20",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"features": [
{
"featureId": "f1000005DC",
"name": "Страна производства",
"indexable": true,
"value": ""
}
],
"category": {
"id": "cat1000224DC",
"name": "Одежда универсальная",
"title": "Одежда универсальная",
"url": "/Odezhda-universalnaya",
"media": {
"id": "02e62a7a-9c76-4cb2-9156-19ee57047ced",
"media": {
"url": "master/catalog/images/1713788986747-1882559365.png",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1713788986747-1882559365.png",
"name": "костюм 2.png",
"type": "PHOTO",
"size": 1013408,
"resolution": "900x1200 px",
"createdDate": "2024-04-22T15:29:48.78"
},
"title": "костюм 2",
"altAttr": "костюм 2",
"description": "",
"sign": "",
"tags": [
""
]
},
"features": [
{
"id": "f1000005DC",
"name": "Страна производства",
"values": [
"",
"Россия",
"Малайзия",
"Узбекистан",
"Канада",
"Беларусь",
"Китай",
"Турция",
"Индия",
"Япония",
"Бразилия"
],
"createdDate": "2023-11-30T14:25:26.884"
}
],
"type": "WITH_PRODUCTS",
"parentCategoryId": null,
"level": 1,
"order": 76,
"seo": {
"title": "Глобальный Шаблон 2 title %name-category%",
"keywords": "Глобальный Шаблон keywords %name-product% %name-category%",
"description": "Глобальный шаблон description %name-product% в %name-category% от %price-min% до %price-max%"
},
"catalogId": "master-catalog"
},
"status": 100,
"catalogId": "master-catalog",
"variants": [
{
"id": "1019683DC",
"externalId": null,
"barcode": null,
"nomenclature": null,
"productId": "1019682DC",
"name": "Спортивная футболка",
"description": "Классная футболка для спорта.",
"assets": [],
"attributes": [],
"status": 100
}
]
}
200 - операция выполнена успешно, товар обновлен
- Редактирование варианта товара - PATCH запрос, /v2/products/variants
{
"filter": {//критерии, по которым отфильтровываются варианты товаров для редактирования
},
"body": {// изменения, для внесения в отфильтрованные товары
}
Отсутствует.
200 - операция выполнена успешно, вариант(-ы) товара обновлен(-ы)
- Получение списка вариантов товара - POST запрос, /v1/products/variants/list
{
"searchTerm": "ботинки мужские",
"catalogId": "master-catalog"
}
[
{
"id": "1001673DC",
"externalId": "22",
"productId": "1001672DC",
"name": "Ботинки мужские ECCO TURN",
"description": "В демисезонных мужских ботинках из промасленного нубука ECCO TURN не страшна любая непогода. Климатическая мембрана надежно защищает от воды и ветра, а удобная анатомическая подошва делают любой день комфортнее.\nПолиуретановая подошва легкая, гибкая и хорошо сохраняет устойчивость при ходьбе. Регулируемая шнуровка обеспечивает более плотную посадку обуви по ноге.",
"assets": [
{
"id": "43d4b502-5bb9-4593-9a19-90fc5b965097",
"media": {
"url": "master/catalog/images/1706867586522-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706867586522-1882559365.jpg",
"name": "490053-01178-s_rendition_Print.jpg",
"type": "PHOTO",
"size": 228130,
"resolution": "2806x3508 px",
"createdDate": "2024-02-02T12:53:56.171"
},
"title": "490053-01178-s_rendition_Print",
"altAttr": "490053-01178-s_rendition_Print",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "size",
"name": "Размер",
"indexable": true,
"value": "43"
}
],
"status": 300,
"orderable": false
},
{
"id": "1001674DC",
"externalId": "33",
"productId": "1001672DC",
"name": "Ботинки мужские ECCO TURN",
"description": "В демисезонных мужских ботинках из промасленного нубука ECCO TURN не страшна любая непогода. Климатическая мембрана надежно защищает от воды и ветра, а удобная анатомическая подошва делают любой день комфортнее.\nПолиуретановая подошва легкая, гибкая и хорошо сохраняет устойчивость при ходьбе. Регулируемая шнуровка обеспечивает более плотную посадку обуви по ноге.",
"assets": [
{
"id": "885b9803-a630-422b-8592-5ec6a1cd7186",
"media": {
"url": "master/catalog/images/1706904654047-1882559365.jpg",
"absoluteUrl": "https://test-ecom-media.digitalchief.tech/master/catalog/images/1706904654047-1882559365.jpg",
"name": "2.jpg",
"type": "PHOTO",
"size": 61410,
"resolution": "1280x1280 px",
"createdDate": "2024-02-02T23:10:58.358"
},
"title": "2",
"altAttr": "2",
"description": "",
"sign": "",
"tags": [
""
]
}
],
"attributes": [
{
"featureId": "size",
"name": "Размер",
"indexable": true,
"value": "42"
}
],
"status": 300,
"orderable": false
}
]
200 - операция выполнена успешно, получен список вариантов товара