Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

getVariantsStep - Medusa Core Workflows Reference

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

This step retrieves variants matching the specified filters.

Example#

Code
1const data = getVariantsStep({2  filter: {3    id: "variant_123"4  }5})

Input#

GetVariantsStepInputGetVariantsStepInput
The details of the variants to retrieve.
filterFilterableProductVariantPropsOptional
The filters to apply on retrieved product variants.
configFindConfig<ProductVariantDTO>Optional
An object that is used to configure how an entity is retrieved from the database. It accepts as a typed parameter an Entity class, which provides correct typing of field names in its properties.

Output#

ProductVariantDTO[]ProductVariantDTO[]
ProductVariantDTOProductVariantDTO
A product variant's data.
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
⇧↵