softDeletePriceLists - Pricing Module Reference

Beta

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

This method soft deletes price lists by their IDs.

Example

await pricingModuleService.softDeletePriceLists([
  "plist_123",
  "plist_321",
])

Parameters

priceListIdsstring[]Required

The IDs of the price lists.

configSoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContext

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

Returns

PromisePromise<void | Record<string, string[]>>Required

An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated price list rules. The object's keys are the ID attribute names of the price list entity's relations, such as price_list_rule_id, and its value is an array of strings, each being the ID of a record associated with the price list through this relation, such as the IDs of associated price list rule. If there are no related records, the promise resolves to void.