Feed categories

Toolset feed_categories, 13 tools.

RecordsCopy Anchor Link

feed_category_attributesCopy Anchor Link

The attributes a site requires for the category a store category maps to, and what each is filled from (fixed values, a product attribute or an option). Get takes <tree id>/<store category id>.

• Permission: feeds.read
• Tools: feed_category_attributes_get

feed_category_nodeCopy Anchor Link

A category of a site's list, found by words, to map a store category to. List only; node_id is what feed_category_map takes.

• Permission: feeds.read
• Tools: feed_category_node_list

Filters on the list:

feed_category_statusCopy Anchor Link

How a feed's categories stand: which store categories its products are in and whether each is mapped. Pass the feed ID.

• Permission: feeds.read
• Tools: feed_category_status_get

feed_category_treeCopy Anchor Link

A site's category list that store categories are mapped to. List shows each tree with its size and mapping progress. Get takes <tree id>@<language> and returns the mapping screen: every store category with the site category it maps to, its suggestion and the products it relists.

• Permission: feeds.read
• Tools: feed_category_tree_list, feed_category_tree_get

Filters on the list:

feed_product_categoryCopy Anchor Link

The site category a product goes into on each tree: from its store category mapping, or its own override. Pass the product ID.

• Permission: feeds.read
• Tools: feed_product_category_get

ActionsCopy Anchor Link

feed_category_accept_suggestionsCopy Anchor Link

Apply exactly the store-category to site-category matches the merchant accepted.

• Action key: feed_category.accept_suggestions
• 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:

{
  "tree_id": "google-hu",
  "pairs": [
    {
      "category_id": "019bb50f-c863-7fa2-b8ae-0d6b18758e24",
      "node_id": "187"
    }
  ]
}

feed_category_attributes_setCopy Anchor Link

Set what the attributes a site requires for a category are filled from.

Each value is fixed values ({kind: fixed, values}), a product attribute ({kind: product_attribute, key}) or a variant option ({kind: option, key}); null clears it. Read feed_category_attributes_get for the attribute keys the site requires.

• Action key: feed_category_attributes.set
• Permission: feeds.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "tree_id": "google-hu",
  "category_id": "019bb50f-c863-7fa2-b8ae-0d6b18758e24",
  "values": [
    {
      "attribute_key": "color",
      "value": {
        "kind": "product_attribute",
        "key": "colour"
      }
    }
  ]
}

feed_category_mapCopy Anchor Link

Map a store product category to a site category, or remove its mapping.

Mapping changes where the category's live products are listed on the site, relisting them. A dry run reports the live products it would relist, per site, and writes nothing. node_id null removes the mapping. copy_down also applies it to the subcategories without their own mapping.

• Action key: feed_category.map
• 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 inputs:

{
  "tree_id": "google-hu",
  "category_id": "019bb50f-c863-7fa2-b8ae-0d6b18758e24",
  "node_id": "187"
}

{
  "tree_id": "google-hu",
  "category_id": "019bb50f-c863-7fa2-b8ae-0d6b18758e24",
  "node_id": null
}

feed_category_set_copy_downCopy Anchor Link

Switch whether a mapped store category also applies to its subcategories without their own mapping.

• Action key: feed_category.set_copy_down
• 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:

{
  "tree_id": "google-hu",
  "category_id": "019bb50f-c863-7fa2-b8ae-0d6b18758e24",
  "copy_down": true
}

feed_category_suggestCopy Anchor Link

Ask the site and AI for the site categories the name matching left open; suggestions are kept, never applied.

Spends AI credits and asks the site per category, so one round can take up to two minutes. Pass the next of the previous answer as after to continue. Apply the suggestions the merchant accepts with feed_category_accept_suggestions.

• Action key: feed_category.suggest
• Permission: feeds.write
• Approval: Always waits for a person to approve it.
• Effect: Changes a draft; nothing goes live until it is published.
• Retries: safe to repeat with the same input.

Example input:

{
  "tree_id": "google-hu",
  "language": "hu"
}

feed_category_tree_loadCopy Anchor Link

Load a site's category list in a language, or take the site's much shorter list.

list full loads every category of the site in that language (and the feeds' languages); shorter takes the site's much shorter list.

• Action key: feed_category_tree.load
• Permission: feeds.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example input:

{
  "tree_id": "google-hu",
  "language": "hu",
  "list": "full"
}

feed_product_category_setCopy Anchor Link

Put one product into a site category whatever its store category maps to, or remove that override.

• Action key: feed_product_category.set
• Permission: feeds.write
• Approval: Waits for approval when the store requires it for this action.
• Effect: Changes the live store.
• Retries: safe to repeat with the same input.

Example inputs:

{
  "tree_id": "google-hu",
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "node_id": "187"
}

{
  "tree_id": "google-hu",
  "product_id": "019bb58e-0ec1-79c1-9f40-d39d8d07674b",
  "node_id": null
}