Skip to main content

Class: DiscountService

Provides layer to manipulate discounts.

Implements

Hierarchy

  • TransactionBaseService

    DiscountService

Constructors

constructor

new DiscountService(__namedParameters)

Parameters

NameType
__namedParametersObject

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/discount.ts:69

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10


__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9


__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:11


customerService_

Protected Readonly customerService_: CustomerService

Defined in

packages/medusa/src/services/discount.ts:56


discountConditionRepository_

Protected Readonly discountConditionRepository_: typeof DiscountConditionRepository

Defined in

packages/medusa/src/services/discount.ts:60


discountConditionService_

Protected Readonly discountConditionService_: DiscountConditionService

Defined in

packages/medusa/src/services/discount.ts:61


discountRepository_

Protected Readonly discountRepository_: typeof DiscountRepository

Defined in

packages/medusa/src/services/discount.ts:55


discountRuleRepository_

Protected Readonly discountRuleRepository_: typeof DiscountRuleRepository

Defined in

packages/medusa/src/services/discount.ts:57


eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/discount.ts:66


featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

packages/medusa/src/services/discount.ts:67


giftCardRepository_

Protected Readonly giftCardRepository_: typeof GiftCardRepository

Defined in

packages/medusa/src/services/discount.ts:58


manager_

Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/discount.ts:52


newTotalsService_

Protected Readonly newTotalsService_: NewTotalsService

Defined in

packages/medusa/src/services/discount.ts:63


productService_

Protected Readonly productService_: ProductService

Defined in

packages/medusa/src/services/discount.ts:64


regionService_

Protected Readonly regionService_: RegionService

Defined in

packages/medusa/src/services/discount.ts:65


totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/src/services/discount.ts:62


transactionManager_

Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/discount.ts:53

Methods

addRegion

addRegion(discountId, regionId): Promise<Discount>

Adds a region to the discount regions array.

Parameters

NameTypeDescription
discountIdstringid of discount
regionIdstringid of region to add

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/src/services/discount.ts:513


atomicPhase_

Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

Type parameters

Name
TResult
TError

Parameters

NameTypeDescription
work(transactionManager: EntityManager) => Promise<TResult>the transactional work to be done
isolationOrErrorHandler?IsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?(error: TError) => Promise<void | TResult>Potential error handler

Returns

Promise<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50


calculateDiscountForLineItem

calculateDiscountForLineItem(discountId, lineItem, calculationContextData): Promise<number>

Parameters

NameType
discountIdstring
lineItemLineItem
calculationContextDataCalculationContextData

Returns

Promise<number>

Defined in

packages/medusa/src/services/discount.ts:614


canApplyForCustomer

canApplyForCustomer(discountRuleId, customerId): Promise<boolean>

Parameters

NameType
discountRuleIdstring
customerIdundefined | string

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:793


create

create(discount): Promise<Discount>

Creates a discount with provided data given that the data is validated. Normalizes discount code to uppercase.

Parameters

NameTypeDescription
discountCreateDiscountInputthe discount data to create

Returns

Promise<Discount>

the result of the create operation

Defined in

packages/medusa/src/services/discount.ts:187


createDynamicCode

createDynamicCode(discountId, data): Promise<Discount>

Creates a dynamic code for a discount id.

Parameters

NameTypeDescription
discountIdstringthe id of the discount to create a code for
dataCreateDynamicDiscountInputthe object containing a code to identify the discount by

Returns

Promise<Discount>

the newly created dynamic code

Defined in

packages/medusa/src/services/discount.ts:441


delete

delete(discountId): Promise<void>

Deletes a discount idempotently

Parameters

NameTypeDescription
discountIdstringid of discount to delete

Returns

Promise<void>

the result of the delete operation

Defined in

packages/medusa/src/services/discount.ts:573


deleteDynamicCode

deleteDynamicCode(discountId, code): Promise<void>

Deletes a dynamic code for a discount id.

Parameters

NameTypeDescription
discountIdstringthe id of the discount to create a code for
codestringthe code to identify the discount by

Returns

Promise<void>

the newly created dynamic code

Defined in

packages/medusa/src/services/discount.ts:492


hasExpired

hasExpired(discount): boolean

Parameters

NameType
discountDiscount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:762


hasNotStarted

hasNotStarted(discount): boolean

Parameters

NameType
discountDiscount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:758


hasReachedLimit

hasReachedLimit(discount): boolean

Parameters

NameType
discountDiscount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:752


isDisabled

isDisabled(discount): boolean

Parameters

NameType
discountDiscount

Returns

boolean

Defined in

packages/medusa/src/services/discount.ts:770


isValidForRegion

isValidForRegion(discount, region_id): Promise<boolean>

Parameters

NameType
discountDiscount
region_idstring

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:774


list

list(selector?, config?): Promise<Discount[]>

Parameters

NameTypeDescription
selectorFilterableDiscountPropsthe query object for find
configFindConfig<Discount>the config object containing query settings

Returns

Promise<Discount[]>

the result of the find operation

Defined in

packages/medusa/src/services/discount.ts:125


listAndCount

listAndCount(selector?, config?): Promise<[Discount[], number]>

Parameters

NameTypeDescription
selectorFilterableDiscountPropsthe query object for find
configFindConfig<Discount>the config object containing query settings

Returns

Promise<[Discount[], number]>

the result of the find operation

Defined in

packages/medusa/src/services/discount.ts:141


listByCodes

listByCodes(discountCodes, config?): Promise<Discount[]>

List all the discounts corresponding to the given codes

Parameters

NameTypeDescription
discountCodesstring[]discount codes of discounts to retrieve
configFindConfig<Discount>the config object containing query settings

Returns

Promise<Discount[]>

the discounts

Defined in

packages/medusa/src/services/discount.ts:314


removeRegion

removeRegion(discountId, regionId): Promise<Discount>

Removes a region from the discount regions array.

Parameters

NameTypeDescription
discountIdstringid of discount
regionIdstringid of region to remove

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/src/services/discount.ts:548


retrieve

retrieve(discountId, config?): Promise<Discount>

Gets a discount by id.

Parameters

NameTypeDescription
discountIdstringid of discount to retrieve
configFindConfig<Discount>the config object containing query settings

Returns

Promise<Discount>

the discount

Defined in

packages/medusa/src/services/discount.ts:253


retrieveByCode

retrieveByCode(discountCode, config?): Promise<Discount>

Gets the discount by discount code.

Parameters

NameTypeDescription
discountCodestringdiscount code of discount to retrieve
configFindConfig<Discount>the config object containing query settings

Returns

Promise<Discount>

the discount

Defined in

packages/medusa/src/services/discount.ts:286


shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

NameType
errRecord<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31


update

update(discountId, update): Promise<Discount>

Updates a discount.

Parameters

NameTypeDescription
discountIdstringdiscount id of discount to update
updateUpdateDiscountInputthe data to update the discount with

Returns

Promise<Discount>

the result of the update operation

Defined in

packages/medusa/src/services/discount.ts:344


validateDiscountForCartOrThrow

validateDiscountForCartOrThrow(cart, discount): Promise<void>

Parameters

NameType
cartCart
discountDiscount | Discount[]

Returns

Promise<void>

Defined in

packages/medusa/src/services/discount.ts:687


validateDiscountForProduct

validateDiscountForProduct(discountRuleId, productId): Promise<boolean>

Parameters

NameType
discountRuleIdstring
productIdundefined | string

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/discount.ts:587


validateDiscountRule_

validateDiscountRule_<T>(discountRule): T

Creates a discount rule with provided data given that the data is validated.

Type parameters

NameType
Textends Object

Parameters

NameTypeDescription
discountRuleTthe discount rule to create

Returns

T

the result of the create operation

Defined in

packages/medusa/src/services/discount.ts:107


withTransaction

withTransaction(transactionManager?): DiscountService

Parameters

NameType
transactionManager?EntityManager

Returns

DiscountService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14