Skip to main content

Class: FulfillmentProviderService

Helps retrive fulfillment providers

Hierarchy​

  • TransactionBaseServiceCopy to Clipboard

    ↳ FulfillmentProviderServiceCopy to Clipboard

Constructors​

constructor​

• new FulfillmentProviderService(containerCopy to Clipboard)

Parameters​

NameType
containerCopy to ClipboardFulfillmentProviderContainerCopy to Clipboard

Overrides​

TransactionBaseService.constructor

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:47

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

container_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard container_: FulfillmentProviderContainerCopy to Clipboard

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:43

fulfillmentProviderRepository_​

• ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentProviderRepository_: typeof FulfillmentProviderRepositoryCopy to Clipboard

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:45

manager_​

• ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides​

TransactionBaseService.manager_

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:40

transactionManager_​

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

Overrides​

TransactionBaseService.transactionManager_

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:41

Methods​

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

calculatePrice​

▸ calculatePrice(optionCopy to Clipboard, dataCopy to Clipboard, cart?Copy to Clipboard): PromiseCopy to Clipboard<numberCopy to Clipboard>

Parameters​

NameType
optionCopy to ClipboardShippingOptionCopy to Clipboard
dataCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
cart?Copy to ClipboardCartCopy to Clipboard | OrderCopy to Clipboard

Returns​

PromiseCopy to Clipboard<numberCopy to Clipboard>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:151

canCalculate​

▸ canCalculate(optionCopy to Clipboard): PromiseCopy to Clipboard<booleanCopy to Clipboard>

Parameters​

NameType
optionCopy to ClipboardCalculateOptionPriceInputCopy to Clipboard

Returns​

PromiseCopy to Clipboard<booleanCopy to Clipboard>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:126

cancelFulfillment​

▸ cancelFulfillment(fulfillmentCopy to Clipboard): PromiseCopy to Clipboard<FulfillmentCopy to Clipboard>

Parameters​

NameType
fulfillmentCopy to ClipboardFulfillmentCopy to Clipboard

Returns​

PromiseCopy to Clipboard<FulfillmentCopy to Clipboard>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:144

createFulfillment​

▸ createFulfillment(methodCopy to Clipboard, itemsCopy to Clipboard, orderCopy to Clipboard, fulfillmentCopy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
methodCopy to ClipboardShippingMethodCopy to Clipboard
itemsCopy to ClipboardLineItemCopy to Clipboard[]
orderCopy to ClipboardCreateFulfillmentOrderCopy to Clipboard
fulfillmentCopy to ClipboardOmitCopy to Clipboard<FulfillmentCopy to Clipboard, "beforeInsert"Copy to Clipboard>

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:111

createReturn​

▸ createReturn(returnOrderCopy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
returnOrderCopy to ClipboardCreateReturnTypeCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:169

list​

▸ list(): PromiseCopy to Clipboard<FulfillmentProviderCopy to Clipboard[]>

Returns​

PromiseCopy to Clipboard<FulfillmentProviderCopy to Clipboard[]>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:71

listFulfillmentOptions​

▸ listFulfillmentOptions(providerIdsCopy to Clipboard): PromiseCopy to Clipboard<FulfillmentOptionsCopy to Clipboard[]>

Parameters​

NameType
providerIdsCopy to ClipboardstringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<FulfillmentOptionsCopy to Clipboard[]>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:79

registerInstalledProviders​

▸ registerInstalledProviders(providersCopy to Clipboard): PromiseCopy to Clipboard<voidCopy to Clipboard>

Parameters​

NameType
providersCopy to ClipboardstringCopy to Clipboard[]

Returns​

PromiseCopy to Clipboard<voidCopy to Clipboard>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:57

retrieveDocuments​

▸ retrieveDocuments(providerIdCopy to Clipboard, fulfillmentDataCopy to Clipboard, documentTypeCopy to Clipboard): PromiseCopy to Clipboard<anyCopy to Clipboard>

Fetches documents from the fulfillment provider

Parameters​

NameTypeDescription
providerIdCopy to ClipboardstringCopy to Clipboardthe id of the provider
fulfillmentDataCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>the data relating to the fulfillment
documentTypeCopy to Clipboard"label"Copy to Clipboard | "invoice"Copy to Clipboardthe typ of

Returns​

PromiseCopy to Clipboard<anyCopy to Clipboard>

document to fetch

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:188

retrieveProvider​

▸ retrieveProvider(providerIdCopy to Clipboard): anyCopy to Clipboard

Parameters​

NameTypeDescription
providerIdCopy to ClipboardstringCopy to Clipboardthe provider id

Returns​

anyCopy to Clipboard

the payment fulfillment provider

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:100

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

validateFulfillmentData​

▸ validateFulfillmentData(optionCopy to Clipboard, dataCopy to Clipboard, cartCopy to Clipboard): PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Parameters​

NameType
optionCopy to ClipboardShippingOptionCopy to Clipboard
dataCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>
cartCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | CartCopy to Clipboard

Returns​

PromiseCopy to Clipboard<RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:131

validateOption​

▸ validateOption(optionCopy to Clipboard): PromiseCopy to Clipboard<booleanCopy to Clipboard>

Parameters​

NameType
optionCopy to ClipboardShippingOptionCopy to Clipboard

Returns​

PromiseCopy to Clipboard<booleanCopy to Clipboard>

Defined in​

packages/medusa/src/services/fulfillment-provider.ts:164

withTransaction​

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

Parameters​

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns​

FulfillmentProviderServiceCopy to Clipboard

Inherited from​

TransactionBaseService.withTransaction

Defined in​

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