Menu

updateProductsStep - Medusa Core Workflows Reference

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

This step updates one or more products.

Example#

To update products by their ID:

Code
1const data = updateProductsStep({2  products: [3    {4      id: "prod_123",5      title: "Shirt"6    }7  ]8})

To update products matching a filter:

Code
1const data = updateProductsStep({2  selector: {3    collection_id: "collection_123",4  },5  update: {6    material: "cotton",7  }8})

Input#

UpdateProductsStepInputUpdateProductsStepInput
The details of the products update.
selectorFilterableProductProps
The filters to select the products to update.
updateUpdateProductDTO
The data to update the products with.
productsUpsertProductDTO[]
The data to create or update products.

Output#

ProductDTO[]ProductDTO[]
idstring
The ID of the product.
titlestring
The title of the product.
handlestring
The handle of the product. The handle can be used to create slug URL paths.
subtitlenull | string
The subttle of the product.
descriptionnull | string
The description of the product.
is_giftcardboolean
Whether the product is a gift card.
statusProductStatus
The status of the product.
thumbnailnull | string
The URL of the product's thumbnail.
widthnull | number
The width of the product.
weightnull | number
The weight of the product.
lengthnull | number
The length of the product.
heightnull | number
The height of the product.
origin_countrynull | string
The origin country of the product.
hs_codenull | string
The HS Code of the product.
mid_codenull | string
The MID Code of the product.
materialnull | string
The material of the product.
collectionnull | ProductCollectionDTO
The associated product collection.
collection_idnull | string
The associated product collection id.
typenull | ProductTypeDTO
The associated product type.
type_idnull | string
The associated product type id.
tagsProductTagDTO[]
The associated product tags.
variantsProductVariantDTO[]
The associated product variants.
optionsProductOptionDTO[]
The associated product options.
imagesProductImageDTO[]
The associated product images.
external_idnull | string
The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain a reference to the ID in the integrated service.
created_atstring | Date
When the product was created.
updated_atstring | Date
When the product was updated.
deleted_atstring | Date
When the product was deleted.
categoriesnull | ProductCategoryDTO[]Optional
The associated product categories.
discountablebooleanOptional
Whether the product can be discounted.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵