FulfillmentProviderService
Helps retrieve fulfillment providers
constructor
Parameters
container
FulfillmentProviderContainerRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequiredcontainer_
FulfillmentProviderContainerRequired__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredMethods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
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
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>Requiredthe 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
Promise<TResult>Requiredthe result of the transactional work
registerInstalledProviders
Parameters
providers
string[]RequiredReturns
Promise
Promise<void>Requiredlist
Returns
listFulfillmentOptions
Parameters
providerIds
string[]RequiredReturns
Promise
Promise<FulfillmentOptions[]>RequiredretrieveProvider
Parameters
providerId
stringRequiredthe provider id
Returns
any
anyRequiredthe payment fulfillment provider
createFulfillment
Parameters
order
CreateFulfillmentOrderRequiredReturns
Promise
Promise<Record<string, unknown>>RequiredcanCalculate
Parameters
option
CalculateOptionPriceInputRequiredReturns
Promise
Promise<boolean>RequiredvalidateFulfillmentData
Parameters
data
Record<string, unknown>RequiredReturns
Promise
Promise<Record<string, unknown>>RequiredcancelFulfillment
Parameters
Returns
calculatePrice
Parameters
Returns
Promise
Promise<number>RequiredvalidateOption
Parameters
Returns
Promise
Promise<boolean>RequiredcreateReturn
Parameters
returnOrder
CreateReturnTypeRequiredReturns
Promise
Promise<Record<string, unknown>>RequiredretrieveDocuments
Fetches documents from the fulfillment provider
Parameters
providerId
stringRequiredthe id of the provider
fulfillmentData
Record<string, unknown>Requiredthe data relating to the fulfillment
documentType
"label" | "invoice"Requiredthe typ of
Returns
Promise
Promise<any>Requireddocument to fetch
Was this section helpful?