upsertPricePreferences - Pricing Module Reference

This documentation provides a reference to the upsertPricePreferences 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.

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

This method updates existing price preferences, or creates new ones if they don't exist.

Example#

Code
1const pricePreferences = await pricingModuleService.upsertPricePreferences([2  {3     id: "prpref_123",4     attribute: 'region_id',5     value: 'DE',6     is_tax_inclusive: true7  },8])

Parameters#

dataUpsertPricePreferenceDTO[]

The attributes to update or create for each price preference.

sharedContextContextOptional

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

Returns#

PromisePromise<PricePreferenceDTO[]>

The updated and created price preferences.

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

This method updates the price preference if it exists, or creates a new ones if it doesn't.

Example#

Code
1const pricePreference = await pricingModuleService.upsertPricePreferences(2  {3     id: "prpref_123",4     attribute: 'region_id',5     value: 'DE',6     is_tax_inclusive: true7  }8)

Parameters#

dataUpsertPricePreferenceDTO

The attributes to update or create for the new price preference.

sharedContextContextOptional

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

Returns#

PromisePromise<PricePreferenceDTO>

The updated or created price preference.