Files
medusa-store/docs/content/references/services/classes/FulfillmentProviderService.md
2022-07-06 17:11:05 +03:00

5.1 KiB

Class: FulfillmentProviderService

Helps retrive fulfillment providers

Constructors

constructor

new FulfillmentProviderService(container)

Parameters

Name Type
container any

Defined in

services/fulfillment-provider.js:7

Methods

calculatePrice

calculatePrice(option, data, cart): Promise<any>

Parameters

Name Type
option any
data any
cart any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:79


canCalculate

canCalculate(option): Promise<any>

Parameters

Name Type
option any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:64


cancelFulfillment

cancelFulfillment(fulfillment): Promise<any>

Parameters

Name Type
fulfillment any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:74


createFulfillment

createFulfillment(method, items, order, fulfillment): Promise<any>

Parameters

Name Type
method any
items any
order any
fulfillment any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:59


createReturn

createReturn(returnOrder): Promise<any>

Parameters

Name Type
returnOrder any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:89


list

list(): Promise<any>

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:23


listFulfillmentOptions

listFulfillmentOptions(providers): Promise<any[]>

Parameters

Name Type
providers any

Returns

Promise<any[]>

Defined in

services/fulfillment-provider.js:30


registerInstalledProviders

registerInstalledProviders(providers): Promise<void>

Parameters

Name Type
providers any

Returns

Promise<void>

Defined in

services/fulfillment-provider.js:12


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 any the data relating to the fulfillment
documentType "invoice" | "label" the typ of document to fetch

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:102


retrieveProvider

retrieveProvider(provider_id): FulfillmentService

Parameters

Name Type Description
provider_id string the provider id

Returns

FulfillmentService

the payment fulfillment provider

Defined in

services/fulfillment-provider.js:48


validateFulfillmentData

validateFulfillmentData(option, data, cart): Promise<any>

Parameters

Name Type
option any
data any
cart any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:69


validateOption

validateOption(option): Promise<any>

Parameters

Name Type
option any

Returns

Promise<any>

Defined in

services/fulfillment-provider.js:84