FulfillmentProviderService

Helps retrieve fulfillment providers

Hierarchy

• TransactionBaseService

  ↳ FulfillmentProviderService

Constructors

constructor

new FulfillmentProviderService(container)

Parameters

Name
container

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/fulfillment-provider.ts:44

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

---

container_

Protected Readonly container_: FulfillmentProviderContainer

Defined in

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

---

fulfillmentProviderRepository_

Protected Readonly fulfillmentProviderRepository_: Repository<FulfillmentProvider>

Defined in

medusa/src/services/fulfillment-provider.ts:42

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

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

---

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

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

---

calculatePrice

calculatePrice(option, data, cart?): Promise<number>

Parameters

Name
option
data
cart?

Returns

Promise<number>

-Promise: -number: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:147

---

canCalculate

canCalculate(option): Promise<boolean>

Parameters

Name
option

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:122

---

cancelFulfillment

cancelFulfillment(fulfillment): Promise<Fulfillment>

Parameters

Name
fulfillment

Returns

Promise<Fulfillment>

-Promise: -Fulfillment:

Defined in

medusa/src/services/fulfillment-provider.ts:140

---

createFulfillment

createFulfillment(method, items, order, fulfillment): Promise<Record<string, unknown>>

Parameters

Name
method
items
order
fulfillment

Returns

Promise<Record<string, unknown>>

-Promise: -Record: -string: (optional) -unknown: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:107

---

createReturn

createReturn(returnOrder): Promise<Record<string, unknown>>

Parameters

Name
returnOrder

Returns

Promise<Record<string, unknown>>

-Promise: -Record: -string: (optional) -unknown: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:165

---

list

list(): Promise<FulfillmentProvider[]>

Returns

Promise<FulfillmentProvider[]>

-Promise: -FulfillmentProvider[]: -FulfillmentProvider:

Defined in

medusa/src/services/fulfillment-provider.ts:67

---

listFulfillmentOptions

listFulfillmentOptions(providerIds): Promise<FulfillmentOptions[]>

Parameters

Name
providerIds

Returns

Promise<FulfillmentOptions[]>

-Promise: -FulfillmentOptions[]:

Defined in

medusa/src/services/fulfillment-provider.ts:75

---

registerInstalledProviders

registerInstalledProviders(providers): Promise<void>

Parameters

Name
providers

Returns

Promise<void>

-Promise:

Defined in

medusa/src/services/fulfillment-provider.ts:53

---

retrieveDocuments

retrieveDocuments(providerId, fulfillmentData, documentType): Promise<any>

Fetches documents from the fulfillment provider

Parameters

Name	Description
providerId	string
fulfillmentData	Record<string, unknown>
documentType	"label" | "invoice"

Returns

Promise<any>

-Promise: document to fetch -any: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:184

---

retrieveProvider

retrieveProvider(providerId): any

Parameters

Name	Description
providerId	string

Returns

any

-any: (optional) the payment fulfillment provider

Defined in

medusa/src/services/fulfillment-provider.ts:96

---

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

---

validateFulfillmentData

validateFulfillmentData(option, data, cart): Promise<Record<string, unknown>>

Parameters

Name
option
data
cart

Returns

Promise<Record<string, unknown>>

-Promise: -Record: -string: (optional) -unknown: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:127

---

validateOption

validateOption(option): Promise<boolean>

Parameters

Name
option

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/fulfillment-provider.ts:160

---

withTransaction

withTransaction(transactionManager?): FulfillmentProviderService

Parameters

Name
transactionManager?

Returns

FulfillmentProviderService

-FulfillmentProviderService:

Inherited from

TransactionBaseService.withTransaction

Defined in

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