Skip to content

Latest commit

 

History

History

maintain-collections-by-product-metafield-values

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Maintain collections by product metafield values

Tags: Bulk, Collections, Metafields, Products

This task will scan your entire catalog to maintain products in collections based on metafield values. Configure the task with a metafield namespace and key (separated by a period, e.g. "custom.color"), and a list of metafield string values paired with collection IDs. If the value of a product's metafield matches any of the configured ones, then the product will be added to that collection. Conversely, products in a configured collection which do not match a metafield value will be removed.

Default options

{
  "metafield_namespace_and_key__required": null,
  "metafield_values_and_collection_ids__keyval_number_required": null
}

Learn about task options in Mechanic

Subscriptions

mechanic/shopify/bulk_operation
mechanic/scheduler/daily  
mechanic/user/trigger

Learn about event subscriptions in Mechanic

Documentation

This task will scan your entire catalog to maintain products in collections based on metafield values. Configure the task with a metafield namespace and key (separated by a period, e.g. "custom.color"), and a list of metafield string values paired with collection IDs. If the value of a product's metafield matches any of the configured ones, then the product will be added to that collection. Conversely, products in a configured collection which do not match a metafield value will be removed.

Important notes:

  • This task only checks the values of metafields that are of type single_line_text_field or list.single_line_text_field. For list type metafields, the product will qualify for collection membership if any of the list values matches a metafield value. More information on Shopify metafield types can be found here.
  • Adding and removing products from collections are both handled in the background by Shopify jobs, after the Mechanic task run is complete. Expect a delay in final results in your shop for task runs involving very large additions or removals.

Installing this task

Find this task in the library at tasks.mechanic.dev, and use the "Try this task" button. Or, import this task's JSON export – see Importing and exporting tasks to learn how imports work.

Contributions

Found a bug? Got an improvement to add? Start here: ../../CONTRIBUTING.md.

Task requests

Submit your task requests for consideration by the Mechanic community, and they may be chosen for development and inclusion in the task library!