Product recommendations RSS feed API handler
Retrieve product recommendation feeds for integration with external recommendation engines.
GET Product Recommendations RSS Feed
HTTP Verb – GET
URL – /api/v1/productsrssfeed
Description – Get the product recommendations RSS feed XML file
Base – HandlerBase\<GetProductRecommendationsRssFeedParameter, GetProductRecommendationsRssFeedResult\>
Handlers –
| Order | Handler | Description |
|---|---|---|
| 500 | ValidateContext | If the ProductRssFeedEnforceApiKey setting is enabled, validates that the request contains a "Key" header matching the configured ProductRssFeedApiKey. Returns Forbidden error if validation fails. |
| 600 | GetFileName | Constructs the file name for the RSS feed using the current website name: ProductRecommendationFeed/Products_RSS_Feed-\{WebsiteName}.xml. |
| 700 | GetFile | Checks if the feed file exists in system storage. Returns NotFound error if the file does not exist. Opens the file and sets the result Content as a StreamContent. |
GET Product Recommendations Order Feed
HTTP Verb – GET
URL – /api/v1/orderfeed
Description – Get the product recommendations order history feed XML file
Base – HandlerBase\<GetProductRecommendationsOrderFeedParameter, GetProductRecommendationsOrderFeedResult\>
Handlers –
| Order | Handler | Description |
|---|---|---|
| 500 | ValidateContext | If the ProductRssFeedEnforceApiKey setting is enabled, validates that the request contains a "Key" header matching the configured ProductRssFeedApiKey. Returns Forbidden error if validation fails. |
| 600 | GetFileName | Constructs the file name based on the source parameter. If GetOfflineOrdersOnly is true, uses ProductRecommendationOfflineFeed/All_Offline_Orders.xml. Otherwise uses ProductRecommendationHistoricalFeed/\{WebsiteName}_Historical_Orders.xml. |
| 700 | GetFile | Checks if the feed file exists in system storage. Returns NotFound error if the file does not exist. Opens the file and sets the result Content as a StreamContent. |
Updated about 6 hours ago
