softDeletePrices - Pricing Module Reference
This documentation provides a reference to the softDeletePrices
method. This belongs to the Pricing Module.
This method soft deletes prices by their IDs.
Example
Parameters
priceIds
string[]RequiredThe IDs of the prices.
config
SoftDeleteReturn<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.
config
SoftDeleteReturn<TReturnableLinkableKeys>Returns
Promise
Promise<void | Record<string, string[]>>RequiredAn object that includes the IDs of related records that were also soft deleted, such as the ID of the associated price rules.
The object's keys are the ID attribute names of the price entity's relations, such as price_rule_id
, and its value is an array of strings, each being the ID of a record associated
with the price through this relation, such as the IDs of associated price rule.
If there are no related records, the promise resolves to void
.
Promise
Promise<void | Record<string, string[]>>Requiredprice_rule_id
, and its value is an array of strings, each being the ID of a record associated
with the price through this relation, such as the IDs of associated price rule.
If there are no related records, the promise resolves to void
.Was this section helpful?