Фиды для Я.Маркета
- /api/lite/feed/settings
- /api/lite/feed/settings/download_yml
- /api/lite/feed/market_attributes
- /api/lite/feed/refresh
/api/lite/feed/settings
Список фидов(подробная информация по фиду) (/api/lite/feed/settings)
/api/lite/feed/settings
Положительный результат запроса:
{
"success": true,
"recordsTotal": 1,
"settings": [
{
"success": true,
"id": "83dcafbd-ba01-9742-88c0-03746cbfca48",
"name": "Фид для маркета",
"cloudUrl": "https://storage.yandexcloud.net/images-k2c/0de5d740-b2d4-4425-9490-7f5153daa698.xml",
"cloudId": "0de5d740-b2d4-4425-9490-7f5153daa698",
"active": false,
"lastUpdate": null,
"collections": [
"1001"
],
"shopName": "Магазин 01",
"shopUrl": "https://lumene.ru/", //Адрес магазина, влияет на тег <url>https://lumene.ru/</url>
"shopOfferUrl": "https://lumene.ru/catalog/{UTM}#/item/{ID}", //Шаблон адреса товара.
"companyName": "ООО ААА",
"deliveryEnabled": true,
"selfPickupEnabled": true,
"nonPreorderEnabled": false,
"deliveryMethods": [
{
"deliveryPrice": 150,
"minDays": 1,
"maxDays": 3,
"placeOrderHour": 18
}
],
"pickupMethods": [
{
"deliveryPrice": 0,
"minDays": 1,
"maxDays": 1,
"placeOrderHour": 0
}
],
"adult": false,
"offerNameFormat": "NAME",
"utm": "utm_token=12332&utm_source=ya.ru",
"salesNote": "Все товары сертифицированы",
"useOfferGroups": true,
"attrMatching": {
"manufacturer_warranty": "warranty"
},
"priceCode": null,
"oldPriceCode": "Цена до скидки"
}
]
}Пейджинация
Для пейджинации используются параметры page и size: size - заказов на странице, page - номер страницы.
Пример: /api/lite/feed/settings?page=0&size=200
Если параметры не переданы, то дефолтные значения page=0&size=100
Также, для отображение пейджинации следует анализировать параметр recordsTotal, возвращающий общее количество записей (с учетом примененной фильтрации, если она есть).
параметр: id (Идентификатор фида, если передан, возвращается подробная информация по фиду)
например /api/lite/feed/settings?id=83dcafbd-ba01-9742-88c0-03746cbfca48
Положительный результат запроса:
{
"success": true,
"id": "83dcafbd-ba01-9742-88c0-03746cbfca48",
"name": "Фид для маркета",
"cloudUrl": null,
"cloudId": null,
"active": false,
"lastUpdate": null,
"collections": [
"1001"
],
"shopName": "Магазин 01",
"shopUrl": "https://shop.ru/",
"shopOfferUrl": "https://shop.ru/catalog/{UTM}#/item/{ID}",
"companyName": "ООО ААА",
"deliveryEnabled": true,
"selfPickupEnabled": true,
"nonPreorderEnabled": false,
"deliveryMethods": [
{
"deliveryPrice": 150,
"minDays": 1,
"maxDays": 3,
"placeOrderHour": 18
}
],
"pickupMethods": [
{
"deliveryPrice": 0,
"minDays": 1,
"maxDays": 1,
"placeOrderHour": 0
}
],
"adult": false,
"offerNameFormat": "NAME",
"utm": "utm_token=12332&utm_source=ya.ru",
"salesNote": "Все товары сертифицированы",
"useOfferGroups": true,
"attrMatching": {
"manufacturer_warranty": "warranty"
},
"priceCode": null,
"oldPriceCode": "Цена до скидки",
"checkStock": false, //Проставлять отсутствующим товарам флаг "под заказ"
"excludeZeroStock":false, //Исключать из фида товар с нулевыми остатками
"warehouseCode": null //ИД склада
}
Отрицательный результат запроса:
Пример ошибки
{
"success": false,
"errors": [
{
"code": 0,
"message": "текст ошибки"
}
]
}Обновить настройки фида (/api/lite/feed/settings)
/api/lite/feed/settings
Пример запроса:
{
"id": "83dcafbd-ba01-9742-88c0-03746cbfca48", //если не задан, то создаётся новый фид
"name": "Фид для маркета",
"active": false,
"collections": [
"1001"
],
"shopName": "Магазин 01",
"shopUrl": "https://shop.ru/", //Адрес магазина, влияет на тег <url>https://shop.ru/</url>
"shopOfferUrl": "https://shop.ru/catalog/{UTM}#/item/{ID}", //Шаблон адреса товара.
"companyName": "ООО ААА",
"deliveryEnabled": true,
"selfPickupEnabled": true,
"nonPreorderEnabled": true,
"deliveryMethods": [{"deliveryPrice":150, "minDays":1, "maxDays":3, "placeOrderHour":18}],
"pickupMethods": [{"deliveryPrice":0, "minDays":1, "maxDays":1, "placeOrderHour":0}],
"adult": false,
"offerNameFormat": "NAME", //NAME_COLLECTION_PARENTHESES | NAME_COLLECTION_COLON
"utm": "utm_token=12332&utm_source=ya.ru",
"salesNote": "Все товары сертифицированы",
"useOfferGroups": true,
"attrMatching": {"manufacturer_warranty":"warranty", "sales_notes": "notes"}, //"код в маркете" : "код в кактусе"
"priceCode": "Розничная цена",
"oldPriceCode": "Цена до скидки"
"updateInterval": 10, //Интервал автообновления фида, минуты. Минимально - 10 мин. По умолчанию: 24 * 60 = 1440 минут
"checkStock": false, //Проверять наличие товара на складе, влияет на параметр available в теге <offer>. false по умолчанию
"excludeZeroStock":false, //Исключать из фида товар с нулевыми остатками. false по умолчанию
"warehouseCode": null //ид склада остатков (guid). если не указан, остатки проверяются на всех складах. null по умолчанию
}Положительный результат запроса:
Пример
{
"success": true,
}Отрицательный результат запроса:
Пример ошибки
{
"success": false,
"errors": [
{
"code": 0,
"message": "текст ошибки"
}
]
}Удаление фида
/api/lite/feed/settings&id=
параметр: id (Идентификатор фида)
например /api/lite/feed/settings?id=83dcafbd-ba01-9742-88c0-03746cbfca48
Успех:
{
"success": true,
}Ошибка:
{
"success": false,
"errors": [
{
"code": 0,
"message": "текст ошибки"
}
]
}/api/lite/feed/settings/download_yml
Сгенерировать и скачать yml файл (/api/lite/feed/settings/download_yml)
/api/lite/feed/settings/download_yml?id=
параметр: id (идентификатор фида)
например /api/lite/feed/settings/download_yml?id=83dcafbd-ba01-9742-88c0-03746cbfca48
Успех:
application/octet-stream
Ошибка:
status 500
{
"timestamp": "2020-04-03T10:38:46.343+0000",
"status": 500,
"error": "Internal Server Error",
"message": "12345",
"path": "/api/lite/feed/settings/download_yml"
}/api/lite/feed/market_attributes
Список возможных атрибутов Я.Маркета(/api/lite/feed/market_attributes)
Возвращает все возможные атрибуты из маркета.
Служит ключом в маппинге "attrMatching"
* Для получения всех атрибутов продукта в кактусе есть метод: /api/lite/products/attributes
(код атрибута продукта служит значением в маппинге "attrMatching")
/api/lite/feed/market_attributes
Положительный результат запроса:
{
"success": true,
"marketAttributes": [
{
"id": "available",
"name": "Статус товара (в наличие/на заказ)"
},
{
"id": "bid",
"name": "Ставка"
},
{
"id": "url",
"name": "URL страницы товара "
},
{
"id": "oldPrice",
"name": "Старая цена товара"
},
{
"id": "vendor",
"name": "Производитель"
},
{
"id": "vendorCode",
"name": "Код производителя"
},
{
"id": "model",
"name": "Модель"
},
{
"id": "sales_notes",
"name": "Комментарий к товару"
},
{
"id": "description",
"name": "Описание товарного предложения"
},
{
"id": "name",
"name": "Название товарного предложения"
},
{
"id": "delivery",
"name": "Возможность курьерской доставки"
},
{
"id": "pickup",
"name": "Возможность самовывоза"
},
{
"id": "store",
"name": "Возможность купить товар без предварительного заказf"
},
{
"id": "manufacturer_warranty",
"name": "Официальная гарантия производителя (да/нет)"
},
{
"id": "country_of_origin",
"name": "Страна производства товара"
},
{
"id": "adult",
"name": "Товары adult-тематики"
},
{
"id": "age",
"name": "Возрастная категория товара (годы)"
},
{
"id": "downloadable",
"name": "Продукт можно скачать"
}
]
}Отрицательный результат запроса:
Пример ошибки
{
"success": false,
"errors": [
{
"code": 0,
"message": "текст ошибки"
}
]
}/api/lite/feed/refresh
Обновить содержимое фида(в облаке) (/api/lite/feed/refresh)
/api/lite/feed/refresh?id=
Обновляет файл в облаке.
параметр: id (Идентификатор фида) обязательный
Положительный результат запроса:
Пример
{
"success": true,
"id": "83dcafbd-ba01-9742-88c0-03746cbfca48",
"name": "Фид для маркета",
"cloudUrl": "https://storage.yandexcloud.net/images-k2c/0de5d740-b2d4-4425-9490-7f5153daa698.xml",
"cloudId": "0de5d740-b2d4-4425-9490-7f5153daa698.xml",
"active": false,
"lastUpdate": "2020-10-20 19:52:09",
"collections": [
"1001"
],
"shopName": "Магазин 01",
"companyName": "ООО ААА",
"deliveryEnabled": true,
"selfPickupEnabled": true,
"nonPreorderEnabled": false,
"deliveryMethods": [
{
"deliveryPrice": 150,
"minDays": 1,
"maxDays": 3,
"placeOrderHour": 18
}
],
"pickupMethods": [
{
"deliveryPrice": 0,
"minDays": 1,
"maxDays": 1,
"placeOrderHour": 0
}
],
"adult": false,
"offerNameFormat": "NAME",
"utm": "utm_token=12332&utm_source=ya.ru",
"salesNote": "Все товары сертифицированы",
"useOfferGroups": true,
"attrMatching": {
"manufacturer_warranty": "warranty"
},
"priceCode": null,
"oldPriceCode": "Цена до скидки"
}Отрицательный результат запроса:
Пример ошибки
{
"success": false,
"errors": [
{
"code": 0,
"message": "текст ошибки"
}
]
}