Skip to main content

Class: PriceListService

Provides layer to manipulate product tags.

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ PriceListServiceCopy to Clipboard

Constructors​

constructor​

• new PriceListService(__namedParametersCopy to Clipboard)

Parameters​

NameType
__namedParametersCopy to ClipboardPriceListConstructorPropsCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

packages/medusa/src/services/price-list.ts:57

Properties​

__configModule__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

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

__container__​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from​

TransactionBaseService.__container__

Defined in​

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

__moduleDeclaration__​

• ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

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

customerGroupService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard customerGroupService_: CustomerGroupServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:48

featureFlagRouter_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard featureFlagRouter_: FlagRouterCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:55

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.manager_

Defined in​

packages/medusa/src/services/price-list.ts:45

moneyAmountRepo_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard moneyAmountRepo_: typeof MoneyAmountRepositoryCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:53

priceListRepo_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard priceListRepo_: typeof PriceListRepositoryCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:52

productService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productService_: ProductServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:50

productVariantRepo_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantRepo_: typeof ProductVariantRepositoryCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:54

regionService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard regionService_: RegionServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:49

transactionManager_​

• ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.transactionManager_

Defined in​

packages/medusa/src/services/price-list.ts:46

variantService_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard variantService_: ProductVariantServiceCopy to Clipboard

Defined in​

packages/medusa/src/services/price-list.ts:51

Methods​

addCurrencyFromRegion​

▸ ProtectedCopy to Clipboard addCurrencyFromRegion<TCopy to Clipboard>(pricesCopy to Clipboard): PromiseCopy to Clipboard<TCopy to Clipboard[]>

Add currency_codeCopy to Clipboard to an MA record if region_idCopy to Clipboardis passed.

Type parameters​

NameType
TCopy to Clipboardextends PriceListPriceCreateInputCopy to Clipboard | PriceListPriceUpdateInputCopy to Clipboard

Parameters​

NameTypeDescription
pricesCopy to ClipboardTCopy to Clipboard[]a list of PriceListPrice(Create/Update)Input records

Returns​

PromiseCopy to Clipboard<TCopy to Clipboard[]>

updated pricesCopy to Clipboard list

Defined in​

packages/medusa/src/services/price-list.ts:519

addPrices​

▸ addPrices(idCopy to Clipboard, pricesCopy to Clipboard, replace?Copy to Clipboard): PromiseCopy to Clipboard<PriceListCopy to Clipboard>

Adds prices to a price list in bulk, optionally replacing all existing prices

Parameters​

NameTypeDefault valueDescription
idCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboardid of the price list
pricesCopy to ClipboardPriceListPriceCreateInputCopy to Clipboard[]undefinedCopy to Clipboardprices to add
replaceCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboardwhether to replace existing prices

Returns​

PromiseCopy to Clipboard<PriceListCopy to Clipboard>

updated Price List

Defined in​

packages/medusa/src/services/price-list.ts:218

atomicPhase_​

▸ ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters​

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns​

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from​

TransactionBaseService.atomicPhase_

Defined in​

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

clearPrices​

▸ clearPrices(idCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Removes all prices from a price list and deletes the removed prices in bulk

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the price list

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

updated Price List

Defined in​

packages/medusa/src/services/price-list.ts:258

create​

▸ create(priceListObjectCopy to Clipboard): PromiseCopy to Clipboard<PriceListCopy to Clipboard>

Creates a Price List

Parameters​

NameTypeDescription
priceListObjectCopy to ClipboardCreatePriceListInputCopy to Clipboardthe Price List to create

Returns​

PromiseCopy to Clipboard<PriceListCopy to Clipboard>

created Price List

Defined in​

packages/medusa/src/services/price-list.ts:119

delete​

▸ delete(idCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Deletes a Price List Will never fail due to delete being idempotent.

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the price list

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

empty promise

Defined in​

packages/medusa/src/services/price-list.ts:272

deletePrices​

▸ deletePrices(idCopy to Clipboard, priceIdsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Removes prices from a price list and deletes the removed prices in bulk

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardid of the price list
priceIdsCopy to ClipboardstringCopy to Clipboard[]ids of the prices to delete

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

updated Price List

Defined in​

packages/medusa/src/services/price-list.ts:243

deleteProductPrices​

▸ deleteProductPrices(priceListIdCopy to Clipboard, productIdsCopy to Clipboard): PromiseCopy to Clipboard<[stringCopy to Clipboard[], numberCopy to Clipboard]>

Parameters​

NameType
priceListIdCopy to ClipboardstringCopy to Clipboard
productIdsCopy to ClipboardstringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<[stringCopy to Clipboard[], numberCopy to Clipboard]>

Defined in​

packages/medusa/src/services/price-list.ts:446

deleteVariantPrices​

▸ deleteVariantPrices(priceListIdCopy to Clipboard, variantIdsCopy to Clipboard): PromiseCopy to Clipboard<[stringCopy to Clipboard[], numberCopy to Clipboard]>

Parameters​

NameType
priceListIdCopy to ClipboardstringCopy to Clipboard
variantIdsCopy to ClipboardstringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<[stringCopy to Clipboard[], numberCopy to Clipboard]>

Defined in​

packages/medusa/src/services/price-list.ts:483

list​

▸ list(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<PriceListCopy to Clipboard[]>

Lists Price Lists

Parameters​

NameTypeDescription
selectorCopy to ClipboardFilterablePriceListPropsCopy to Clipboardthe query object for find
configCopy to ClipboardFindConfigCopy to Clipboard<FilterablePriceListPropsCopy to Clipboard>the config to be used for find

Returns​

PromiseCopy to Clipboard<PriceListCopy to Clipboard[]>

the result of the find operation

Defined in​

packages/medusa/src/services/price-list.ts:292

listAndCount​

▸ listAndCount(selector?Copy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<[PriceListCopy to Clipboard[], numberCopy to Clipboard]>

Lists Price Lists and adds count

Parameters​

NameTypeDescription
selectorCopy to ClipboardFilterablePriceListPropsCopy to Clipboardthe query object for find
configCopy to ClipboardFindConfigCopy to Clipboard<FilterablePriceListPropsCopy to Clipboard>the config to be used for find

Returns​

PromiseCopy to Clipboard<[PriceListCopy to Clipboard[], numberCopy to Clipboard]>

the result of the find operation

Defined in​

packages/medusa/src/services/price-list.ts:316

listProducts​

▸ listProducts(priceListIdCopy to Clipboard, selector?Copy to Clipboard, config?Copy to Clipboard, requiresPriceList?Copy to Clipboard): PromiseCopy to Clipboard<[ProductCopy to Clipboard[], numberCopy to Clipboard]>

Parameters​

NameTypeDefault value
priceListIdCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
selectorCopy to ClipboardSelectorCopy to Clipboard<ProductCopy to Clipboard> | FilterableProductPropsCopy to Clipboard{}Copy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<ProductCopy to Clipboard>undefinedCopy to Clipboard
requiresPriceListCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboard

Returns​

PromiseCopy to Clipboard<[ProductCopy to Clipboard[], numberCopy to Clipboard]>

Defined in​

packages/medusa/src/services/price-list.ts:364

listVariants​

▸ listVariants(priceListIdCopy to Clipboard, selector?Copy to Clipboard, config?Copy to Clipboard, requiresPriceList?Copy to Clipboard): PromiseCopy to Clipboard<[ProductVariantCopy to Clipboard[], numberCopy to Clipboard]>

Parameters​

NameTypeDefault value
priceListIdCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
selectorCopy to ClipboardFilterableProductVariantPropsCopy to Clipboard{}Copy to Clipboard
configCopy to ClipboardFindConfigCopy to Clipboard<ProductVariantCopy to Clipboard>undefinedCopy to Clipboard
requiresPriceListCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboard

Returns​

PromiseCopy to Clipboard<[ProductVariantCopy to Clipboard[], numberCopy to Clipboard]>

Defined in​

packages/medusa/src/services/price-list.ts:412

retrieve​

▸ retrieve(priceListIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<PriceListCopy to Clipboard>

Retrieves a product tag by id.

Parameters​

NameTypeDescription
priceListIdCopy to ClipboardstringCopy to Clipboardthe id of the product tag to retrieve
configCopy to ClipboardFindConfigCopy to Clipboard<PriceListCopy to Clipboard>the config to retrieve the tag by

Returns​

PromiseCopy to Clipboard<PriceListCopy to Clipboard>

the collection.

Defined in​

packages/medusa/src/services/price-list.ts:88

shouldRetryTransaction_​

▸ ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters​

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns​

booleanCopy to Clipboard

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

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

update​

▸ update(idCopy to Clipboard, updateCopy to Clipboard): PromiseCopy to Clipboard<PriceListCopy to Clipboard>

Updates a Price List

Parameters​

NameTypeDescription
idCopy to ClipboardstringCopy to Clipboardthe id of the Product List to update
updateCopy to ClipboardUpdatePriceListInputCopy to Clipboardthe update to apply

Returns​

PromiseCopy to Clipboard<PriceListCopy to Clipboard>

updated Price List

Defined in​

packages/medusa/src/services/price-list.ts:167

upsertCustomerGroups_​

▸ ProtectedCopy to Clipboard upsertCustomerGroups_(priceListIdCopy to Clipboard, customerGroupsCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
priceListIdCopy to ClipboardstringCopy to Clipboard
customerGroupsCopy to Clipboard{ idCopy to Clipboard: stringCopy to Clipboard }[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

packages/medusa/src/services/price-list.ts:345

withTransaction​

▸ withTransaction(transactionManager?Copy to Clipboard): PriceListServiceCopy to Clipboard

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

PriceListServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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