medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.FulfillmentProviderService.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: FulfillmentProviderService

internal.internal.FulfillmentProviderService

Helps retrieve fulfillment providers

Hierarchy

• TransactionBaseService

  ↳ FulfillmentProviderService

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.configModule

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:5

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.container

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:4

---

__moduleDeclaration__

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.moduleDeclaration

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:6

---

container_

• Protected Readonly container_: FulfillmentProviderContainer

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:24

---

fulfillmentProviderRepository_

• Protected Readonly fulfillmentProviderRepository_: Repository<FulfillmentProvider>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:25

---

manager_

• Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:7

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:8

Accessors

activeManager_

• Protected get activeManager_(): EntityManager

Returns

EntityManager

Inherited from

TransactionBaseService.activeManager_

Defined in

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

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.

Type parameters

Name
TResult
TError

Parameters

Name	Type	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>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:24

---

calculatePrice

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

Parameters

Name	Type
option	ShippingOption
data	Record<string, unknown>
cart?	Order | Cart

Returns

Promise<number>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:39

---

canCalculate

▸ canCalculate(option): Promise<boolean>

Parameters

Name	Type
option	CalculateOptionPriceInput

Returns

Promise<boolean>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:36

---

cancelFulfillment

▸ cancelFulfillment(fulfillment): Promise<Fulfillment>

Parameters

Name	Type
fulfillment	Fulfillment

Returns

Promise<Fulfillment>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:38

---

createFulfillment

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

Parameters

Name	Type
method	ShippingMethod
items	LineItem[]
order	CreateFulfillmentOrder
fulfillment	Omit<Fulfillment, "beforeInsert">

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:35

---

createReturn

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

Parameters

Name	Type
returnOrder	CreateReturnType

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:41

---

list

▸ list(): Promise<FulfillmentProvider[]>

Returns

Promise<FulfillmentProvider[]>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:28

---

listFulfillmentOptions

▸ listFulfillmentOptions(providerIds): Promise<FulfillmentOptions[]>

Parameters

Name	Type
providerIds	string[]

Returns

Promise<FulfillmentOptions[]>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:29

---

registerInstalledProviders

▸ registerInstalledProviders(providers): Promise<void>

Parameters

Name	Type
providers	string[]

Returns

Promise<void>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:27

---

retrieveDocuments

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

Fetches documents from the fulfillment provider

Parameters

Name	Type	Description
providerId	string	the id of the provider
fulfillmentData	Record<string, unknown>	the data relating to the fulfillment
documentType	"label" | "invoice"	the typ of

Returns

Promise<any>

document to fetch

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:49

---

retrieveProvider

▸ retrieveProvider(providerId): any

Parameters

Name	Type	Description
providerId	string	the provider id

Returns

any

the payment fulfillment provider

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:34

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/dist/interfaces/transaction-base-service.d.ts:12

---

validateFulfillmentData

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

Parameters

Name	Type
option	ShippingOption
data	Record<string, unknown>
cart	Record<string, unknown> | Cart

Returns

Promise<Record<string, unknown>>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:37

---

validateOption

▸ validateOption(option): Promise<boolean>

Parameters

Name	Type
option	ShippingOption

Returns

Promise<boolean>

Defined in

packages/medusa/dist/services/fulfillment-provider.d.ts:40

---

withTransaction

▸ withTransaction(transactionManager?): FulfillmentProviderService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

FulfillmentProviderService

Inherited from

TransactionBaseService.withTransaction

Defined in

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