Help

Was this page helpful?

updateProductCategoriesStep - Medusa Core Workflows Reference - Medusa Documentation

updateProductCategoriesStep - Medusa Core Workflows Reference

This documentation provides a reference to the updateProductCategoriesStep. It belongs to the @medusajs/medusa/core-flows package.

This step updates product categories matching specified filters.

Example#

Code
1const data = updateProductCategoriesStep({2  selector: {3    id: "pcat_123",4  },5  update: {6    name: "Shoes",7  }8})

UpdateProductCategoriesStepInputUpdateProductCategoriesStepInput

The data to update the product categories.

The filters to select the product categories to update.

The data to update in the product categories.

ProductCategoryDTO[]ProductCategoryDTO[]

idstring

The ID of the product category.

namestring

The name of the product category.

descriptionstring

The description of the product category.

handlestring

The handle of the product category. The handle can be used to create slug URL paths.

is_activeboolean

Whether the product category is active.

is_internalboolean

Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers.

ranknumber

The ranking of the product category among sibling categories.

parent_categorynull | ProductCategoryDTO

The associated parent category.

parent_category_idnull | string

The associated parent category id.

category_childrenProductCategoryDTO[]

The associated child categories.

productsProductDTO[]

The associated products.

created_atstring | Date

When the product category was created.

updated_atstring | Date

When the product category was updated.

metadataMetadataTypeOptional

The ranking of the product category among sibling categories.

deleted_atstring | DateOptional

When the product category was deleted.