output feeds

Preview

Render a handful of products exactly as the export would, writing nothing.

rule_set_ids lets the page try a different selection before saving it; omitted, the preview uses the sets the feed has actually selected — which is what makes preview and export agree. Products are let through the same way: by the product set the feed sends, read now, or by its own filter (feed_selection), unless filter_document tries another filter first.

post/companies/{company_id}/output-feeds/{output_feed_id}/preview

Request

  • Base URL
    https://app.zalster.com (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Path parameters

company_idstring uuid required

Company id

output_feed_idstring uuid required

Output feed id

Query parameters

themestring nullable

none, scheduled (the default: the company's theme now) or a theme's id

atstring date-time nullable

draw as at this moment, with a time zone; now when left out

Request body

documentobject nullable
filter_documentobject nullable
rule_set_idsstring[] nullable
product_idstring uuid nullable
limitinteger

Response

Successful Response

columnsstring[] required
writableinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.