medusa-store/docs/content/references/services/classes/FulfillmentService.md

Class: FulfillmentService

Hierarchy

• TransactionBaseService<FulfillmentService>

  ↳ FulfillmentService

Constructors

constructor

• new FulfillmentService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedDependencies

Overrides

TransactionBaseService<FulfillmentService&gt;.constructor

Defined in

services/fulfillment.ts:47

Properties

configModule

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

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

fulfillmentProviderService_

• Protected Readonly fulfillmentProviderService_: FulfillmentProviderService

Defined in

services/fulfillment.ts:42

---

fulfillmentRepository_

• Protected Readonly fulfillmentRepository_: typeof FulfillmentRepository

Defined in

services/fulfillment.ts:43

---

lineItemRepository_

• Protected Readonly lineItemRepository_: typeof LineItemRepository

Defined in

services/fulfillment.ts:45

---

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

services/fulfillment.ts:40

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/fulfillment.ts:36

---

shippingProfileService_

• Protected Readonly shippingProfileService_: ShippingProfileService

Defined in

services/fulfillment.ts:41

---

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

services/fulfillment.ts:39

---

trackingLinkRepository_

• Protected Readonly trackingLinkRepository_: typeof TrackingLinkRepository

Defined in

services/fulfillment.ts:44

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/fulfillment.ts:37

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

cancelFulfillment

▸ cancelFulfillment(fulfillmentOrId): Promise<Fulfillment>

Parameters

Name	Type	Description
fulfillmentOrId	string | Fulfillment

Returns

Promise<Fulfillment>

Defined in

services/fulfillment.ts:254

---

createFulfillment

▸ createFulfillment(order, itemsToFulfill, custom?): Promise<Fulfillment[]>

Parameters

Name	Type	Description
order	CreateFulfillmentOrder
itemsToFulfill	FulFillmentItemType[]
custom	Partial<Fulfillment>

Returns

Promise<Fulfillment[]>

Defined in

services/fulfillment.ts:199

---

createShipment

▸ createShipment(fulfillmentId, trackingLinks, config?): Promise<Fulfillment>

Parameters

Name	Type	Description
fulfillmentId	string
trackingLinks	{ tracking_number: string }[]
config	CreateShipmentConfig

Returns

Promise<Fulfillment>

Defined in

services/fulfillment.ts:304

---

getFulfillmentItems_

▸ getFulfillmentItems_(order, items): Promise<(null | LineItem)[]>

Parameters

Name	Type	Description
order	CreateFulfillmentOrder
items	FulFillmentItemType[]

Returns

Promise<(null | LineItem)[]>

Defined in

services/fulfillment.ts:109

---

partitionItems_

▸ partitionItems_(shippingMethods, items): FulfillmentItemPartition[]

Parameters

Name	Type
shippingMethods	ShippingMethod[]
items	LineItem[]

Returns

FulfillmentItemPartition[]

Defined in

services/fulfillment.ts:71

---

retrieve

▸ retrieve(id, config?): Promise<Fulfillment>

Parameters

Name	Type	Description
id	string
config	FindConfig<Fulfillment>

Returns

Promise<Fulfillment>

Defined in

services/fulfillment.ts:166

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

validateFulfillmentLineItem_

▸ validateFulfillmentLineItem_(item, quantity): null | LineItem

Parameters

Name	Type	Description
item	undefined | LineItem
quantity	number

Returns

null | LineItem

Defined in

services/fulfillment.ts:134

---

withTransaction

▸ withTransaction(transactionManager?): FulfillmentService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

FulfillmentService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16