# DiscountService

Provides layer to manipulate discounts.

**Implements**

## Hierarchy

- `TransactionBaseService`

  ↳ **`DiscountService`**

## Constructors

### constructor

**new DiscountService**(`«destructured»`)

#### Parameters

| Name |
| :------ |
| `«destructured»` | `Object` |

#### Overrides

TransactionBaseService.constructor

#### Defined in

[medusa/src/services/discount.ts:71](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L71)

## Properties

### \_\_configModule\_\_

 `Protected` `Optional` `Readonly` **\_\_configModule\_\_**: Record<`string`, `unknown`\>

#### Inherited from

TransactionBaseService.\_\_configModule\_\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:14](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L14)

___

### \_\_container\_\_

 `Protected` `Readonly` **\_\_container\_\_**: `any`

#### Inherited from

TransactionBaseService.\_\_container\_\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:13](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L13)

___

### \_\_moduleDeclaration\_\_

 `Protected` `Optional` `Readonly` **\_\_moduleDeclaration\_\_**: Record<`string`, `unknown`\>

#### Inherited from

TransactionBaseService.\_\_moduleDeclaration\_\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:15](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L15)

___

### customerService\_

 `Protected` `Readonly` **customerService\_**: [`CustomerService`](CustomerService.md)

#### Defined in

[medusa/src/services/discount.ts:58](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L58)

___

### 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](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L62)

___

### discountConditionService\_

 `Protected` `Readonly` **discountConditionService\_**: [`DiscountConditionService`](DiscountConditionService.md)

#### Defined in

[medusa/src/services/discount.ts:63](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L63)

___

### discountRepository\_

 `Protected` `Readonly` **discountRepository\_**: `Repository`<`Discount`\>

#### Defined in

[medusa/src/services/discount.ts:57](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L57)

___

### discountRuleRepository\_

 `Protected` `Readonly` **discountRuleRepository\_**: `Repository`<`DiscountRule`\>

#### Defined in

[medusa/src/services/discount.ts:59](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L59)

___

### eventBus\_

 `Protected` `Readonly` **eventBus\_**: [`EventBusService`](EventBusService.md)

#### Defined in

[medusa/src/services/discount.ts:68](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L68)

___

### featureFlagRouter\_

 `Protected` `Readonly` **featureFlagRouter\_**: `FlagRouter`

#### Defined in

[medusa/src/services/discount.ts:69](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L69)

___

### giftCardRepository\_

 `Protected` `Readonly` **giftCardRepository\_**: `Repository`<`GiftCard`\> & { `listGiftCardsAndCount`: Method listGiftCardsAndCount  }

#### Defined in

[medusa/src/services/discount.ts:60](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L60)

___

### manager\_

 `Protected` **manager\_**: `EntityManager`

#### Inherited from

TransactionBaseService.manager\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:5](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L5)

___

### newTotalsService\_

 `Protected` `Readonly` **newTotalsService\_**: [`NewTotalsService`](NewTotalsService.md)

#### Defined in

[medusa/src/services/discount.ts:65](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L65)

___

### productService\_

 `Protected` `Readonly` **productService\_**: [`ProductService`](ProductService.md)

#### Defined in

[medusa/src/services/discount.ts:66](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L66)

___

### regionService\_

 `Protected` `Readonly` **regionService\_**: [`RegionService`](RegionService.md)

#### Defined in

[medusa/src/services/discount.ts:67](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L67)

___

### totalsService\_

 `Protected` `Readonly` **totalsService\_**: [`TotalsService`](TotalsService.md)

#### Defined in

[medusa/src/services/discount.ts:64](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L64)

___

### transactionManager\_

 `Protected` **transactionManager\_**: `undefined` \| `EntityManager`

#### Inherited from

TransactionBaseService.transactionManager\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:6](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L6)

## Accessors

### activeManager\_

`Protected` `get` **activeManager_**(): `EntityManager`

#### Returns

`EntityManager`

-`EntityManager`: 

#### Inherited from

TransactionBaseService.activeManager\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:8](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L8)

## Methods

### addRegion

**addRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>

Adds a region to the discount regions array.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to add |

#### Returns

`Promise`<`Discount`\>

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

#### Defined in

[medusa/src/services/discount.ts:503](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L503)

___

### 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` | `object` |
| `TError` | `object` |

#### Parameters

| Name | Description |
| :------ | :------ |
| `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`\>

-`Promise`: the result of the transactional work

#### Inherited from

TransactionBaseService.atomicPhase\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:56](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L56)

___

### calculateDiscountForLineItem

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

#### Parameters

| Name |
| :------ |
| `discountId` | `string` |
| `lineItem` | `LineItem` |
| `calculationContextData` | `CalculationContextData` |

#### Returns

`Promise`<`number`\>

-`Promise`: 
	-`number`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:599](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L599)

___

### canApplyForCustomer

**canApplyForCustomer**(`discountRuleId`, `customerId`): `Promise`<`boolean`\>

#### Parameters

| Name |
| :------ |
| `discountRuleId` | `string` |
| `customerId` | `undefined` \| `string` |

#### Returns

`Promise`<`boolean`\>

-`Promise`: 
	-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:791](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L791)

___

### 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` | the discount data to create |

#### Returns

`Promise`<`Discount`\>

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

#### Defined in

[medusa/src/services/discount.ts:178](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L178)

___

### createDynamicCode

**createDynamicCode**(`discountId`, `data`): `Promise`<`Discount`\>

Creates a dynamic code for a discount id.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | the id of the discount to create a code for |
| `data` | `CreateDynamicDiscountInput` | the object containing a code to identify the discount by |

#### Returns

`Promise`<`Discount`\>

-`Promise`: the newly created dynamic code
	-`Discount`: 

#### Defined in

[medusa/src/services/discount.ts:431](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L431)

___

### delete

**delete**(`discountId`): `Promise`<`void`\>

Deletes a discount idempotently

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | id of discount to delete |

#### Returns

`Promise`<`void`\>

-`Promise`: the result of the delete operation

#### Defined in

[medusa/src/services/discount.ts:563](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L563)

___

### deleteDynamicCode

**deleteDynamicCode**(`discountId`, `code`): `Promise`<`void`\>

Deletes a dynamic code for a discount id.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | the id of the discount to create a code for |
| `code` | `string` | the code to identify the discount by |

#### Returns

`Promise`<`void`\>

-`Promise`: the newly created dynamic code

#### Defined in

[medusa/src/services/discount.ts:482](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L482)

___

### hasCustomersGroupCondition

**hasCustomersGroupCondition**(`discount`): `boolean`

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:744](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L744)

___

### hasExpired

**hasExpired**(`discount`): `boolean`

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:760](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L760)

___

### hasNotStarted

**hasNotStarted**(`discount`): `boolean`

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:756](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L756)

___

### hasReachedLimit

**hasReachedLimit**(`discount`): `boolean`

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:750](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L750)

___

### isDisabled

**isDisabled**(`discount`): `boolean`

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:768](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L768)

___

### isValidForRegion

**isValidForRegion**(`discount`, `region_id`): `Promise`<`boolean`\>

#### Parameters

| Name |
| :------ |
| `discount` | `Discount` |
| `region_id` | `string` |

#### Returns

`Promise`<`boolean`\>

-`Promise`: 
	-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:772](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L772)

___

### list

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

#### Parameters

| Name | Description |
| :------ | :------ |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |

#### Returns

`Promise`<`Discount`[]\>

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

#### Defined in

[medusa/src/services/discount.ts:125](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L125)

___

### listAndCount

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

#### Parameters

| Name | Description |
| :------ | :------ |
| `selector` | `FilterableDiscountProps` | the query object for find |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |

#### Returns

`Promise`<[`Discount`[], `number`]\>

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

#### Defined in

[medusa/src/services/discount.ts:142](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L142)

___

### listByCodes

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

List all the discounts corresponding to the given codes

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountCodes` | `string`[] | discount codes of discounts to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |

#### Returns

`Promise`<`Discount`[]\>

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

#### Defined in

[medusa/src/services/discount.ts:307](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L307)

___

### removeRegion

**removeRegion**(`discountId`, `regionId`): `Promise`<`Discount`\>

Removes a region from the discount regions array.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | id of discount |
| `regionId` | `string` | id of region to remove |

#### Returns

`Promise`<`Discount`\>

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

#### Defined in

[medusa/src/services/discount.ts:538](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L538)

___

### retrieve

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

Gets a discount by id.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | id of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |

#### Returns

`Promise`<`Discount`\>

-`Promise`: the discount
	-`Discount`: 

#### Defined in

[medusa/src/services/discount.ts:244](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L244)

___

### retrieveByCode

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

Gets the discount by discount code.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountCode` | `string` | discount code of discount to retrieve |
| `config` | `FindConfig`<`Discount`\> | the config object containing query settings |

#### Returns

`Promise`<`Discount`\>

-`Promise`: the discount
	-`Discount`: 

#### Defined in

[medusa/src/services/discount.ts:278](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L278)

___

### shouldRetryTransaction\_

`Protected` **shouldRetryTransaction_**(`err`): `boolean`

#### Parameters

| Name |
| :------ |
| `err` | Record<`string`, `unknown`\> \| { `code`: `string`  } |

#### Returns

`boolean`

-`boolean`: (optional) 

#### Inherited from

TransactionBaseService.shouldRetryTransaction\_

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:37](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L37)

___

### update

**update**(`discountId`, `update`): `Promise`<`Discount`\>

Updates a discount.

#### Parameters

| Name | Description |
| :------ | :------ |
| `discountId` | `string` | discount id of discount to update |
| `update` | `UpdateDiscountInput` | the data to update the discount with |

#### Returns

`Promise`<`Discount`\>

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

#### Defined in

[medusa/src/services/discount.ts:338](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L338)

___

### validateDiscountForCartOrThrow

**validateDiscountForCartOrThrow**(`cart`, `discount`): `Promise`<`void`\>

#### Parameters

| Name |
| :------ |
| `cart` | `Cart` |
| `discount` | `Discount` \| `Discount`[] |

#### Returns

`Promise`<`void`\>

-`Promise`: 

#### Defined in

[medusa/src/services/discount.ts:672](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L672)

___

### validateDiscountForProduct

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

#### Parameters

| Name |
| :------ |
| `discountRuleId` | `string` |
| `productId?` | `string` |

#### Returns

`Promise`<`boolean`\>

-`Promise`: 
	-`boolean`: (optional) 

#### Defined in

[medusa/src/services/discount.ts:577](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L577)

___

### 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` | the discount rule to create |

#### Returns

`T`

#### Defined in

[medusa/src/services/discount.ts:107](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/services/discount.ts#L107)

___

### withTransaction

**withTransaction**(`transactionManager?`): [`DiscountService`](DiscountService.md)

#### Parameters

| Name |
| :------ |
| `transactionManager?` | `EntityManager` |

#### Returns

[`DiscountService`](DiscountService.md)

-`DiscountService`: 

#### Inherited from

TransactionBaseService.withTransaction

#### Defined in

[medusa/src/interfaces/transaction-base-service.ts:20](https://github.com/medusajs/medusa/blob/0af6e5534/packages/medusa/src/interfaces/transaction-base-service.ts#L20)