dataFeedsPreview
dataFeedsPreview
POST:data_feeds/preview.json

Description

Preview data feed composition for a given product variant.

Permission bit: "data_feeds.read"

Arguments

data: DataFeedPreview!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

fields: [DataFeedFieldCreate!]!


filter_fields: String

A fields specification to filter out data's unused fields (for the filter script)

Valid when: filter_fields's length doesn't exceed 100000 characters


filter_script: String

A script to filter the products/variants (JavaScript)

Valid when: filter_script's length doesn't exceed 100000 characters


options: [KeyValueCreate!]!


template_footer: String

Custom footer template to use for generating the data feed

Valid when: template_footer's length doesn't exceed 100000 characters


template_header: String

Custom header template to use for generating the data feed

Valid when: template_header's length doesn't exceed 100000 characters


template_item: String

Custom item template to use for generating the data feed

Valid when: template_item's length doesn't exceed 100000 characters


variant_id: String!

A unique product variant identifier

Example: "va_EQzGqWoY"


Result

[KeyValue!]

Preview (typescript)

Loading module