dataFeedsCreate
dataFeedsCreate
POST:data_feeds.json

Description

Create one or multiple data feeds.

Permission bit: "data_feeds.create"

Arguments

data: [DataFeedCreate!]!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

align_day: Int

Align the generation time to this week day (1 to 31)


align_minute: Int

Align the generation time to this minute offset (-2880 to 2880)


align_weekday: Int

Align the generation time to this week day (0 to 6, Monday is 0)


fields: [DataFeedFieldCreate!]


filename: String

File name of the data feed without extension

Example: "all_published_products"

Valid when: filename's length doesn't exceed 200 characters


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


name: String!

The name of the data feed

Example: "All Published Products"

Valid when: name is not empty

Valid when: name's length doesn't exceed 200 characters


options: [KeyValueCreate!]


password: String

Password for http basic auth protected access

Example: "6b42a6f52013"

Valid when: password's length doesn't exceed 60 characters


schedule: DataFeedSchedule

How often data feed is updated


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


username: String

User name for http basic auth protected access

Example: "ada79de6ecea"

Valid when: username's length doesn't exceed 60 characters


Result

[DataFeed!]

Preview (typescript)

Loading module