updatePricePreferences - Pricing Module Reference

This documentation provides a reference to the updatePricePreferences method. This belongs to the Pricing Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

updatePricePreferences(id, data, sharedContext?): Promise<PricePreferenceDTO>#

This method is used to update a price preference.

Example#

Code
1const pricePreference = await pricingModuleService.updatePricePreferences(2  "prpref_123",3  {4     is_tax_inclusive: false5  }6)

Parameters#

idstring

The ID of the price preference to be updated.

dataUpdatePricePreferenceDTO

The attributes of the price preference to be updated

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PricePreferenceDTO>

The updated price preference.

updatePricePreferences(selector, data, sharedContext?): Promise<PricePreferenceDTO[]>#

This method is used to update a list of price preferences determined by the selector filters.

Example#

Code
1const pricePreferences = await pricingModuleService.updatePricePreferences(2  {3    id: ["prpref_123", "prpref_321"],4  },5  {6    is_tax_inclusive: false7  }8)

Parameters#

selectorFilterablePricePreferenceProps

The filters that will determine which price preferences will be updated.

dataUpdatePricePreferenceDTO

The attributes to be updated on the selected price preferences

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<PricePreferenceDTO[]>

The updated price preferences.

Was this page helpful?