/feed/{uuid}/preview

  • Mount Point: /resource/rest/feed/{uuid}/preview

The following operations are supported on this resource:

GET

Generates a feed preview with various filters applied using the options provided. The feed being previewed is not required to be active inorder to generate the feed preview using this method.

Parameters

name description type default
uuid The UUID of the feed generate a preview for. path
locale An optional parameter to specify a locale where only products assigned to the locale will be output in the feed. query
modifiedAfter An optional parameter to specify a modified date where only products modified after this date will be output in thefeed. query
onlyUpcomingProducts If the onlyUpcomingProducts parameter is set to true, only products that will become active in the future willbe output in the feed. query false
start Specifies the record to start the feed output at. query 1
count Specifies the number of records to end the feed preview at. query 1000

Output Payload

element produceable content type(s)
(custom)
  • text/xml
description
Feed with preview of products restricted according to parameters. The output of this method is dependent on the XSL being applied.

Exceptions

name description
RESTWebserviceException If an error occurs when trying to generate the feed preview. The XML error message conforms to theREST web services error schema