Menu

createPricePreferencesWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more price preferences. It's used by the Create Price Preferences Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to create price preferences in your custom flows.

Source Code

Examples#

Steps#

createPricePreferencesStep

Workflow hook

Step conditioned by when

View step details

Input#

CreatePricePreferencesWorkflowInputCreatePricePreferencesWorkflowInput
The price preferences to create.
attributestringOptional
The attribute of the price preference. For example, region_id or currency_code.
valuestringOptional
The value of the price preference. For example, reg_123 or usd.
is_tax_inclusivebooleanOptional
Whether prices matching this preference are tax inclusive. Learn more in this documentation.

Output#

PricePreferenceDTO[]PricePreferenceDTO[]
idstring
The ID of a price preference.
attributenull | string
The rule attribute for the preference
valuenull | string
The rule value for the preference
is_tax_inclusiveboolean
Flag specifying whether prices for the specified rule are tax inclusive.
created_atDate
When the price preference was created.
updated_atDate
When the price preference was updated.
deleted_atnull | Date
When the price preference was deleted.
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
⇧↵