Feed rules

Toolset feed_rules, 14 tools.

RecordsCopy Anchor Link

feed_ruleCopy Anchor Link

A rule that leaves out, changes or labels products on feeds: store-wide, or one feed's own. List shows the store-wide rules, or with feed_id the rules that feed runs. Get returns the rule with every saved version, newest first (version numbers for restore).

• Permission: feeds.read
• Tools: feed_rule_list, feed_rule_get

Filters on the list:

feed_rule_catalogCopy Anchor Link

What a rule can use in this store: field paths with types and names, attribute and option keys, operators, formula functions, ready-made rules (templates) with their parameters, label slots, the sites' own conditions and steps, swap tables, currencies and the store time zone. Pass a feed ID, or "store" for the store-wide catalog. A rule is either a ready-made template with its values, or a whole document. Read feed_rule_catalog_get for the template ids with their parameters, the fields, operators and functions a document can use; find keys, values, categories, brands and swap tables with feed_rule_catalog_search_list.

• Permission: feeds.read
• Tools: feed_rule_catalog_get

feed_rule_catalog_searchCopy Anchor Link

Look up what a rule can name when the catalog lists only part of it: fields by English or Hungarian name, attribute and option keys and values, categories, collections, tags, brands and swap tables, by words in any case or accents. value is what the rule writes (a field path, a key, a value, a category or collection id, a table name). List only.

• Permission: feeds.read
• Tools: feed_rule_catalog_search_list

Filters on the list:

feed_rule_statsCopy Anchor Link

Per rule: the products it matches, leaves out and changes, on one feed or summed over all. Pass a feed ID, or "all".

• Permission: feeds.read
• Tools: feed_rule_stats_get

feed_rule_traceCopy Anchor Link

Why one variant is or is not on a feed, rule by rule: each rule that matched and what it did. Get takes <feed id>/<variant id>.

• Permission: feeds.read
• Tools: feed_rule_trace_get

ActionsCopy Anchor Link

feed_rule_createCopy Anchor Link

Create a feed rule and switch it on, after previewing what it does.

A dry run previews it: products left out, added and changed per feed, samples and site problems, and saves nothing. Run it after the merchant has seen the preview. Rules change what comparison sites and marketplaces receive. A rule is either a ready-made template with its values, or a whole document. Read feed_rule_catalog_get for the template ids with their parameters, the fields, operators and functions a document can use; find keys, values, categories, brands and swap tables with feed_rule_catalog_search_list.

• Action key: feed_rule.create
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: runs at most once; a repeat with the same idempotency key returns the first result.
• Dry run: supported, with dry_run set to true.

Example input:

{
  "name": "Hide cheap products",
  "scope": "store",
  "feed_id": null,
  "rule": {
    "kind": "template",
    "template": {
      "id": "exclude_cheap_products",
      "params": {
        "below": 500
      }
    }
  },
  "schedule": null
}

feed_rule_deleteCopy Anchor Link

Delete a feed rule for good; feed_rule_set_enabled keeps it to switch on later.

• Action key: feed_rule.delete
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Destructive: in compact mode it runs with run_destructive_action.
• Retries: safe to repeat with the same input.

Example input:

{
  "rule_id": "019bb2ab-6d1c-7f3d-823d-17d50169da8f",
  "expected_version": 2
}

feed_rule_reorderCopy Anchor Link

Put the rules of one list in a new order: the store-wide rules, or one feed's own.

ids are every rule of that list exactly once, first run first. expected_order is the order as read, so a list changed meanwhile refuses the save.

• Action key: feed_rule.reorder
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "scope": "store",
  "feed_id": null,
  "ids": [
    "019bb2ae-6061-7f9f-8981-f9913ad51dc8",
    "019bb2a8-9b08-7da0-bb68-72c1eaeec333"
  ],
  "expected_order": [
    "019bb2a8-9b08-7da0-bb68-72c1eaeec333",
    "019bb2ae-6061-7f9f-8981-f9913ad51dc8"
  ]
}

feed_rule_restoreCopy Anchor Link

Bring an earlier version of a feed rule back as the newest.

• Action key: feed_rule.restore
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "rule_id": "019bb2ab-6d1c-7f3d-823d-17d50169da8f",
  "version": 1,
  "expected_version": 3
}

feed_rule_set_enabledCopy Anchor Link

Switch a saved feed rule on, or off without deleting it; the feeds it applies to rebuild.

• Action key: feed_rule.set_enabled
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "rule_id": "019bb2ab-6d1c-7f3d-823d-17d50169da8f",
  "enabled": false,
  "expected_version": 2
}

feed_rule_suggestCopy Anchor Link

Three rules worth setting up for the merchant's words, best first, each complete and counted.

The store finds ideas in its own data and a model adds some, each named and explained in the merchant's language. Pass every idea already offered in offered so none repeats. Saves nothing; create the chosen one with feed_rule_create.

• Action key: feed_rule.suggest
• Permission: feeds.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "text": "hide products without a barcode",
  "locale": "en"
}

feed_rule_testCopy Anchor Link

Run up to 20 products through one feed's rules, optionally with a draft rule in place, and see each step.

Test mode: shows each rule step and what the site would get for every variant. Nothing is saved. draft is the rule as it would be (same shape as a rule preview); null tests the saved rules.

• Action key: feed_rule.test
• Permission: feeds.read
• Approval: Runs without approval.
• Effect: Reads only.
• Retries: safe to repeat with the same input.

Example input:

{
  "feed_id": "019bb295-753c-7642-bb09-0ac0eda0f41b",
  "variant_ids": [
    "019bb7f3-10ac-7f8b-b47e-f5cd71dff2e1"
  ]
}

feed_rule_updateCopy Anchor Link

Save a change to a feed rule as its next version, after previewing it.

Only the parts named are replaced (name, rule, schedule). A dry run previews the change per feed and saves nothing; a rename alone needs no preview. expected_version is the version as read from feed_rule_get: a newer one saved meanwhile refuses the change.

• Action key: feed_rule.update
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.
• Dry run: supported, with dry_run set to true.

Example input:

{
  "rule_id": "019bb2ab-6d1c-7f3d-823d-17d50169da8f",
  "expected_version": 2,
  "rule": {
    "kind": "template",
    "template": {
      "id": "exclude_cheap_products",
      "params": {
        "below": 500
      }
    }
  }
}