www/apps/resources/references/pricing/IPricingModuleService/methods/pricing.IPricingModuleService.updatePricePreferences/page.mdx
import { TypeList } from "docs-ui"
This documentation provides a reference to the updatePricePreferences method. This belongs to the Pricing Module.
You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.
</Note>This method is used to update a price preference.
const pricePreference = await pricingModuleService.updatePricePreferences(
"prpref_123",
{
is_tax_inclusive: false
}
)
<TypeList types={[{"name":"id","type":"string","description":"The ID of the price preference to be updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"UpdatePricePreferenceDTO","description":"The attributes of the price preference to be updated","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"null \| string","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"null \| string","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferences"/>
<TypeList types={[{"name":"Promise","type":"Promise<PricePreferenceDTO>","optional":false,"defaultValue":"","description":"The updated price preference.","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"null \| string","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"null \| string","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferences"/>
This method is used to update a list of price preferences determined by the selector filters.
const pricePreferences = await pricingModuleService.updatePricePreferences(
{
id: ["prpref_123", "prpref_321"],
},
{
is_tax_inclusive: false
}
)
<TypeList types={[{"name":"selector","type":"FilterablePricePreferenceProps","description":"The filters that will determine which price preferences will be updated.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Attributes to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Values to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"(FilterablePricePreferenceProps \| BaseFilterable<FilterablePricePreferenceProps>)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Attributes to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Values to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"The IDs to filter the price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"attribute","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Attributes to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"value","type":"string \| string[] \| OperatorMap<string \| string[]>","description":"Values to filter price preferences by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"$and","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"Query<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$eq","type":"ExpandScalar<T> \| ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ne","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$in","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$nin","type":"ExpandScalar<T>[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$not","type":"Query<T>","description":"API wrapper around the remoteQuery","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$gte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lt","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$lte","type":"ExpandScalar<T>","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$like","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$re","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$ilike","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$fulltext","type":"string","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$overlap","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contains","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$contained","type":"string[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$exists","type":"boolean","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"data","type":"UpdatePricePreferenceDTO","description":"The attributes to be updated on the selected price preferences","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"attribute","type":"null \| string","description":"The rule attribute for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"null \| string","description":"The rule value for the preference","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"Context","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type TManager, which is a typed parameter passed to the context to specify the type of the transactionManager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type TManager, which is a typed parameter passed to the context to specify the type of the manager.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"string","description":"A string indicating the isolation level of the context. Possible values are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, or SERIALIZABLE.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"boolean","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"string","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"string","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"runId","type":"string","description":"A string indicating the ID of the current run.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"IMessageAggregator","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"string","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"parentStepIdempotencyKey","type":"string","description":"A string indicating the idempotencyKey of the parent workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"preventReleaseEvents","type":"boolean","description":"preventReleaseEvents","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isCancelling","type":"boolean","description":"A boolean value indicating whether the current workflow execution is being cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cancelingFromParentStep","type":"boolean","description":"Weither or not a sub workflow cancellation is being triggered from a parent step.\nIf true, the parent step will not be triggered by the sub workflow.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferences"/>
<TypeList types={[{"name":"Promise","type":"Promise<PricePreferenceDTO[]>","optional":false,"defaultValue":"","description":"The updated price preferences.","expandable":false,"children":[{"name":"PricePreferenceDTO[]","type":"PricePreferenceDTO[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"id","type":"string","description":"The ID of a price preference.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"attribute","type":"null \| string","description":"The rule attribute for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"null \| string","description":"The rule value for the preference","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_tax_inclusive","type":"boolean","description":"Flag specifying whether prices for the specified rule are tax inclusive.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"Date","description":"When the price preference was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"Date","description":"When the price preference was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"null \| Date","description":"When the price preference was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/learn/fundamentals/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updatePricePreferences"/>