---
displayed_sidebar: servicesSidebar
---

import TypeList from "@site/src/components/TypeList"

# FulfillmentService

Handles Fulfillments

## constructor

### Parameters

<TypeList types={[{"name":"__namedParameters","type":"`InjectedDependencies`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="new FulfillmentService"/>

___

## Properties

<TypeList types={[{"name":"manager_","type":"`EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionManager_","type":"`undefined` \\| `EntityManager`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__container__","type":"`any`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"totalsService_","type":"[TotalsService](services.TotalsService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemService_","type":"[LineItemService](services.LineItemService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shippingProfileService_","type":"[ShippingProfileService](services.ShippingProfileService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentProviderService_","type":"[FulfillmentProviderService](services.FulfillmentProviderService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillmentRepository_","type":"Repository&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"trackingLinkRepository_","type":"Repository&#60;[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)&#62;","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"lineItemRepository_","type":"Repository&#60;[LineItem](../../entities/classes/entities.LineItem.mdx)&#62; & `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"productVariantInventoryService_","type":"[ProductVariantInventoryService](services.ProductVariantInventoryService.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"__configModule__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="FulfillmentService"/>

___

## Accessors

### activeManager\_

#### Returns

<TypeList types={[{"name":"EntityManager","type":"`EntityManager`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="activeManager_"/>

___

## Methods

### withTransaction

#### Parameters

<TypeList types={[{"name":"transactionManager","type":"`EntityManager`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="withTransaction"/>

#### Returns

<TypeList types={[{"name":"this","type":"`this`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="withTransaction"/>

### shouldRetryTransaction\_

#### Parameters

<TypeList types={[{"name":"err","type":"`Record<string, unknown>` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="shouldRetryTransaction_"/>

#### Returns

<TypeList types={[{"name":"boolean","type":"`boolean`","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="shouldRetryTransaction_"/>

### atomicPhase\_

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

<TypeList types={[{"name":"TResult","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"TError","type":"`object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="atomicPhase_"/>

#### Parameters

<TypeList types={[{"name":"work","type":"(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: TError) => Promise&#60;void \\| TResult&#62;","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="atomicPhase_"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;TResult&#62;","optional":false,"defaultValue":"","description":"the result of the transactional work","expandable":false,"children":[]}]}  sectionTitle="atomicPhase_"/>

### partitionItems\_

#### Parameters

<TypeList types={[{"name":"shippingMethods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="partitionItems_"/>

#### Returns

<TypeList types={[{"name":"FulfillmentItemPartition[]","type":"`FulfillmentItemPartition`[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}  sectionTitle="partitionItems_"/>

### getFulfillmentItems\_

Retrieves the order line items, given an array of items.

#### Parameters

<TypeList types={[{"name":"order","type":"`CreateFulfillmentOrder`","description":"the order to get line items from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`FulFillmentItemType`[]","description":"the items to get","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="getFulfillmentItems_"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;(null \\| [LineItem](../../entities/classes/entities.LineItem.mdx))[]&#62;","optional":false,"defaultValue":"","description":"the line items generated by the transformer.","expandable":false,"children":[]}]}  sectionTitle="getFulfillmentItems_"/>

### validateFulfillmentLineItem\_

Checks that a given quantity of a line item can be fulfilled. Fails if the
fulfillable quantity is lower than the requested fulfillment quantity.
Fulfillable quantity is calculated by subtracting the already fulfilled
quantity from the quantity that was originally purchased.

#### Parameters

<TypeList types={[{"name":"item","type":"`undefined` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","description":"the line item to check has sufficient fulfillable\n  quantity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"the quantity that is requested to be fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="validateFulfillmentLineItem_"/>

#### Returns

<TypeList types={[{"name":"null \\| LineItem","type":"`null` \\| [LineItem](../../entities/classes/entities.LineItem.mdx)","optional":false,"defaultValue":"","description":"a line item that has the requested fulfillment quantity\n  set.","expandable":false,"children":[]}]}  sectionTitle="validateFulfillmentLineItem_"/>

### retrieve

Retrieves a fulfillment by its id.

#### Parameters

<TypeList types={[{"name":"fulfillmentId","type":"`string`","description":"the id of the fulfillment to retrieve","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"optional values to include with fulfillmentRepository query","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]}  sectionTitle="retrieve"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the fulfillment","expandable":false,"children":[]}]}  sectionTitle="retrieve"/>

### createFulfillment

Creates an order fulfillment
If items needs to be fulfilled by different provider, we make
sure to partition those items, and create fulfillment for
those partitions.

#### Parameters

<TypeList types={[{"name":"order","type":"`CreateFulfillmentOrder`","description":"order to create fulfillment for","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"itemsToFulfill","type":"`FulFillmentItemType`[]","description":"the items in the order to fulfill","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"custom","type":"Partial&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","description":"potential custom values to add","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]}  sectionTitle="createFulfillment"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]&#62;","optional":false,"defaultValue":"","description":"the created fulfillments","expandable":false,"children":[]}]}  sectionTitle="createFulfillment"/>

### cancelFulfillment

Cancels a fulfillment with the fulfillment provider. Will decrement the
fulfillment\_quantity on the line items associated with the fulfillment.
Throws if the fulfillment has already been shipped.

#### Parameters

<TypeList types={[{"name":"fulfillmentOrId","type":"`string` \\| [Fulfillment](../../entities/classes/entities.Fulfillment.mdx)","description":"the fulfillment object or id.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="cancelFulfillment"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the result of the save operation","expandable":false,"children":[]}]}  sectionTitle="cancelFulfillment"/>

### createShipment

Creates a shipment by marking a fulfillment as shipped. Adds
tracking links and potentially more metadata.

#### Parameters

<TypeList types={[{"name":"fulfillmentId","type":"`string`","description":"the fulfillment to ship","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"`CreateShipmentConfig`","description":"potential configuration settings, such as no\\_notification and metadata","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"trackingLinks","type":"`object`[]","description":"tracking links for the shipment","optional":true,"defaultValue":"","expandable":false,"children":[]}]}  sectionTitle="createShipment"/>

#### Returns

<TypeList types={[{"name":"Promise","type":"Promise&#60;[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)&#62;","optional":false,"defaultValue":"","description":"the shipped fulfillment","expandable":false,"children":[]}]}  sectionTitle="createShipment"/>
