Class: FulfillmentProviderService
Helps retrive fulfillment providers
Hierarchy
TransactionBaseService
↳
FulfillmentProviderService
Constructors
constructor
• new FulfillmentProviderService(container
)
Parameters
Name | Type |
---|---|
container | FulfillmentProviderContainer |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/fulfillment-provider.ts:47
Properties
__configModule__
• Protected
Optional
Readonly
__configModule__: Record
<string
, unknown
>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected
Readonly
__container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected
Optional
Readonly
__moduleDeclaration__: Record
<string
, unknown
>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
container_
• Protected
Readonly
container_: FulfillmentProviderContainer
Defined in
packages/medusa/src/services/fulfillment-provider.ts:43
fulfillmentProviderRepository_
• Protected
Readonly
fulfillmentProviderRepository_: typeof FulfillmentProviderRepository
Defined in
packages/medusa/src/services/fulfillment-provider.ts:45
manager_
• Protected
manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/fulfillment-provider.ts:40
transactionManager_
• Protected
transactionManager_: undefined
| EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/fulfillment-provider.ts:41
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/src/interfaces/transaction-base-service.ts:50
calculatePrice
▸ calculatePrice(option
, data
, cart?
): Promise
<number
>
Parameters
Name | Type |
---|---|
option | ShippingOption |
data | Record <string , unknown > |
cart? | Cart | Order |
Returns
Promise
<number
>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:151
canCalculate
▸ canCalculate(option
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
option | CalculateOptionPriceInput |
Returns
Promise
<boolean
>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:126
cancelFulfillment
▸ cancelFulfillment(fulfillment
): Promise
<Fulfillment
>
Parameters
Name | Type |
---|---|
fulfillment | Fulfillment |
Returns
Promise
<Fulfillment
>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:144
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/src/services/fulfillment-provider.ts:111
createReturn
▸ createReturn(returnOrder
): Promise
<Record
<string
, unknown
>>
Parameters
Name | Type |
---|---|
returnOrder | CreateReturnType |
Returns
Promise
<Record
<string
, unknown
>>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:169
list
▸ list(): Promise
<FulfillmentProvider
[]>
Returns
Promise
<FulfillmentProvider
[]>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:71
listFulfillmentOptions
▸ listFulfillmentOptions(providerIds
): Promise
<FulfillmentOptions
[]>
Parameters
Name | Type |
---|---|
providerIds | string [] |
Returns
Promise
<FulfillmentOptions
[]>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:79
registerInstalledProviders
▸ registerInstalledProviders(providers
): Promise
<void
>
Parameters
Name | Type |
---|---|
providers | string [] |
Returns
Promise
<void
>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:57
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/src/services/fulfillment-provider.ts:188
retrieveProvider
▸ retrieveProvider(providerId
): any
Parameters
Name | Type | Description |
---|---|---|
providerId | string | the provider id |
Returns
any
the payment fulfillment provider
Defined in
packages/medusa/src/services/fulfillment-provider.ts:100
shouldRetryTransaction_
▸ Protected
shouldRetryTransaction_(err
): boolean
Parameters
Name | Type |
---|---|
err | Record <string , unknown > | { code : string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
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/src/services/fulfillment-provider.ts:131
validateOption
▸ validateOption(option
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
option | ShippingOption |
Returns
Promise
<boolean
>
Defined in
packages/medusa/src/services/fulfillment-provider.ts:164
withTransaction
▸ withTransaction(transactionManager?
): FulfillmentProviderService
Parameters
Name | Type |
---|---|
transactionManager? | EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14