DiscountService

Provides layer to manipulate discounts.

Implements

Hierarchy

• TransactionBaseService

  ↳ DiscountService

Constructors

constructor

new DiscountService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/discount.ts:71

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

customerService_

Protected Readonly customerService_: CustomerService

Defined in

medusa/src/services/discount.ts:58

---

discountConditionRepository_

Protected Readonly discountConditionRepository_: Repository<DiscountCondition> & { addConditionResources: Method addConditionResources ; canApplyForCustomer: Method canApplyForCustomer ; findOneWithDiscount: Method findOneWithDiscount ; getJoinTableResourceIdentifiers: Method getJoinTableResourceIdentifiers ; isValidForProduct: Method isValidForProduct ; queryConditionTable: Method queryConditionTable ; removeConditionResources: Method removeConditionResources }

Defined in

medusa/src/services/discount.ts:62

---

discountConditionService_

Protected Readonly discountConditionService_: DiscountConditionService

Defined in

medusa/src/services/discount.ts:63

---

discountRepository_

Protected Readonly discountRepository_: Repository<Discount>

Defined in

medusa/src/services/discount.ts:57

---

discountRuleRepository_

Protected Readonly discountRuleRepository_: Repository<DiscountRule>

Defined in

medusa/src/services/discount.ts:59

---

eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/discount.ts:68

---

featureFlagRouter_

Protected Readonly featureFlagRouter_: FlagRouter

Defined in

medusa/src/services/discount.ts:69

---

giftCardRepository_

Protected Readonly giftCardRepository_: Repository<GiftCard> & { listGiftCardsAndCount: Method listGiftCardsAndCount }

Defined in

medusa/src/services/discount.ts:60

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

newTotalsService_

Protected Readonly newTotalsService_: NewTotalsService

Defined in

medusa/src/services/discount.ts:65

---

productService_

Protected Readonly productService_: ProductService

Defined in

medusa/src/services/discount.ts:66

---

regionService_

Protected Readonly regionService_: RegionService

Defined in

medusa/src/services/discount.ts:67

---

totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/discount.ts:64

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

addRegion

addRegion(discountId, regionId): Promise<Discount>

Adds a region to the discount regions array.

Parameters

Name	Description
discountId	string
regionId	string

Returns

Promise<Discount>

-Promise: the result of the update operation -Discount:

Defined in

medusa/src/services/discount.ts:503

---

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.

Name
TResult
TError

Parameters

Name	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

calculateDiscountForLineItem

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

Parameters

Name
discountId
lineItem
calculationContextData

Returns

Promise<number>

-Promise: -number: (optional)

Defined in

medusa/src/services/discount.ts:599

---

canApplyForCustomer

canApplyForCustomer(discountRuleId, customerId): Promise<boolean>

Parameters

Name
discountRuleId
customerId

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/discount.ts:791

---

create

create(discount): Promise<Discount>

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

Parameters

Name	Description
discount	CreateDiscountInput

Returns

Promise<Discount>

-Promise: the result of the create operation -Discount:

Defined in

medusa/src/services/discount.ts:178

---

createDynamicCode

createDynamicCode(discountId, data): Promise<Discount>

Creates a dynamic code for a discount id.

Parameters

Name	Description
discountId	string
data	CreateDynamicDiscountInput

Returns

Promise<Discount>

-Promise: the newly created dynamic code -Discount:

Defined in

medusa/src/services/discount.ts:431

---

delete

delete(discountId): Promise<void>

Deletes a discount idempotently

Parameters

Name	Description
discountId	string

Returns

Promise<void>

-Promise: the result of the delete operation

Defined in

medusa/src/services/discount.ts:563

---

deleteDynamicCode

deleteDynamicCode(discountId, code): Promise<void>

Deletes a dynamic code for a discount id.

Parameters

Name	Description
discountId	string
code	string

Returns

Promise<void>

-Promise: the newly created dynamic code

Defined in

medusa/src/services/discount.ts:482

---

hasCustomersGroupCondition

hasCustomersGroupCondition(discount): boolean

Parameters

Name
discount

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/discount.ts:744

---

hasExpired

hasExpired(discount): boolean

Parameters

Name
discount

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/discount.ts:760

---

hasNotStarted

hasNotStarted(discount): boolean

Parameters

Name
discount

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/discount.ts:756

---

hasReachedLimit

hasReachedLimit(discount): boolean

Parameters

Name
discount

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/discount.ts:750

---

isDisabled

isDisabled(discount): boolean

Parameters

Name
discount

Returns

boolean

-boolean: (optional)

Defined in

medusa/src/services/discount.ts:768

---

isValidForRegion

isValidForRegion(discount, region_id): Promise<boolean>

Parameters

Name
discount
region_id

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/discount.ts:772

---

list

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

Parameters

Name	Description
selector	FilterableDiscountProps
config	FindConfig<Discount>

Returns

Promise<Discount[]>

-Promise: the result of the find operation -Discount[]: -Discount:

Defined in

medusa/src/services/discount.ts:125

---

listAndCount

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

Parameters

Name	Description
selector	FilterableDiscountProps
config	FindConfig<Discount>

Returns

Promise<[Discount[], number]>

-Promise: the result of the find operation -Discount[]: -number: (optional)

Defined in

medusa/src/services/discount.ts:142

---

listByCodes

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

List all the discounts corresponding to the given codes

Parameters

Name	Description
discountCodes	string[]
config	FindConfig<Discount>

Returns

Promise<Discount[]>

-Promise: the discounts -Discount[]: -Discount:

Defined in

medusa/src/services/discount.ts:307

---

removeRegion

removeRegion(discountId, regionId): Promise<Discount>

Removes a region from the discount regions array.

Parameters

Name	Description
discountId	string
regionId	string

Returns

Promise<Discount>

-Promise: the result of the update operation -Discount:

Defined in

medusa/src/services/discount.ts:538

---

retrieve

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

Gets a discount by id.

Parameters

Name	Description
discountId	string
config	FindConfig<Discount>

Returns

Promise<Discount>

-Promise: the discount -Discount:

Defined in

medusa/src/services/discount.ts:244

---

retrieveByCode

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

Gets the discount by discount code.

Parameters

Name	Description
discountCode	string
config	FindConfig<Discount>

Returns

Promise<Discount>

-Promise: the discount -Discount:

Defined in

medusa/src/services/discount.ts:278

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

update

update(discountId, update): Promise<Discount>

Updates a discount.

Parameters

Name	Description
discountId	string
update	UpdateDiscountInput

Returns

Promise<Discount>

-Promise: the result of the update operation -Discount:

Defined in

medusa/src/services/discount.ts:338

---

validateDiscountForCartOrThrow

validateDiscountForCartOrThrow(cart, discount): Promise<void>

Parameters

Name
cart
discount

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/discount.ts:672

---

validateDiscountForProduct

validateDiscountForProduct(discountRuleId, productId?): Promise<boolean>

Parameters

Name
discountRuleId
productId?

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/discount.ts:577

---

validateDiscountRule_

validateDiscountRule_<T>(discountRule): T

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

Name	Type
T	object

Parameters

Name	Description
discountRule	T

Returns

T

Defined in

medusa/src/services/discount.ts:107

---

withTransaction

withTransaction(transactionManager?): DiscountService

Parameters

Name
transactionManager?

Returns

DiscountService

-DiscountService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20