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

Class: SwapService

Handles swaps

Hierarchy

• TransactionBaseService

  ↳ SwapService

Constructors

constructor

• new SwapService(__namedParameters)

Parameters

Name	Type
__namedParameters	InjectedProps

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/swap.ts:96

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

---

cartService_

• Protected Readonly cartService_: CartService

Defined in

packages/medusa/src/services/swap.ts:82

---

customShippingOptionService_

• Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

packages/medusa/src/services/swap.ts:92

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/swap.ts:83

---

fulfillmentService_

• Protected Readonly fulfillmentService_: FulfillmentService

Defined in

packages/medusa/src/services/swap.ts:88

---

lineItemAdjustmentService_

• Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

packages/medusa/src/services/swap.ts:91

---

lineItemService_

• Protected Readonly lineItemService_: LineItemService

Defined in

packages/medusa/src/services/swap.ts:87

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/swap.ts:77

---

orderService_

• Protected Readonly orderService_: OrderService

Defined in

packages/medusa/src/services/swap.ts:84

---

paymentProviderService_

• Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

packages/medusa/src/services/swap.ts:90

---

productVariantInventoryService_

• Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

packages/medusa/src/services/swap.ts:94

---

returnService_

• Protected Readonly returnService_: ReturnService

Defined in

packages/medusa/src/services/swap.ts:85

---

shippingOptionService_

• Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

packages/medusa/src/services/swap.ts:89

---

swapRepository_

• Protected Readonly swapRepository_: typeof SwapRepository

Defined in

packages/medusa/src/services/swap.ts:80

---

totalsService_

• Protected Readonly totalsService_: TotalsService

Defined in

packages/medusa/src/services/swap.ts:86

---

transactionManager_

• Protected transactionManager_: undefined | EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/swap.ts:78

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
FULFILLMENT_CREATED	string
PAYMENT_CAPTURED	string
PAYMENT_CAPTURE_FAILED	string
PAYMENT_COMPLETED	string
PROCESS_REFUND_FAILED	string
RECEIVED	string
REFUND_PROCESSED	string
SHIPMENT_CREATED	string

Defined in

packages/medusa/src/services/swap.ts:65

Methods

areReturnItemsValid

▸ Protected areReturnItemsValid(returnItems): Promise<boolean>

Parameters

Name	Type
returnItems	WithRequiredProperty<Partial<ReturnItem>, "item_id">[]

Returns

Promise<boolean>

Defined in

packages/medusa/src/services/swap.ts:1226

---

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

---

cancel

▸ cancel(swapId): Promise<Swap>

Cancels a given swap if possible. A swap can only be canceled if all related returns, fulfillments, and payments have been canceled. If a swap is associated with a refund, it cannot be canceled.

Parameters

Name	Type	Description
swapId	string	the id of the swap to cancel.

Returns

Promise<Swap>

the canceled swap.

Defined in

packages/medusa/src/services/swap.ts:842

---

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<Swap>

Cancels a fulfillment (if related to a swap)

Parameters

Name	Type	Description
fulfillmentId	string	the ID of the fulfillment to cancel

Returns

Promise<Swap>

updated swap

Defined in

packages/medusa/src/services/swap.ts:1043

---

create

▸ create(order, returnItems, additionalItems?, returnShipping?, custom?): Promise<Swap>

Creates a swap from an order, with given return items, additional items and an optional return shipping method.

Parameters

Name	Type	Description
order	Order	the order to base the swap off
returnItems	WithRequiredProperty<Partial<ReturnItem>, "item_id">[]	the items to return in the swap
additionalItems?	Pick<LineItem, "variant_id" | "quantity">[]	the items to send to the customer
returnShipping?	Object	an optional shipping method for returning the returnItems
returnShipping.option_id	string	-
returnShipping.price?	number	-
custom	Object	contains relevant custom information. This object may include no_notification which will disable sending notification when creating swap. If set, it overrules the attribute inherited from the order
custom.allow_backorder?	boolean	-
custom.idempotency_key?	string	-
custom.no_notification?	boolean	-

Returns

Promise<Swap>

the newly created swap

Defined in

packages/medusa/src/services/swap.ts:317

---

createCart

▸ createCart(swapId, customShippingOptions?): Promise<Swap>

Creates a cart from the given swap. The cart can be used to pay for differences associated with the swap. The swap represented by the swapId must belong to the order. Fails if there is already a cart on the swap.

Parameters

Name	Type	Default value	Description
swapId	string	undefined	the id of the swap to create the cart from
customShippingOptions	{ option_id: string ; price: number }[]	[]	the shipping options

Returns

Promise<Swap>

the swap with its cart_id prop set to the id of the new cart.

Defined in

packages/medusa/src/services/swap.ts:571

---

createFulfillment

▸ createFulfillment(swapId, config?): Promise<Swap>

Fulfills the additional items associated with the swap. Will call the fulfillment providers associated with the shipping methods.

Parameters

Name	Type	Description
swapId	string	the id of the swap to fulfill,
config	CreateShipmentConfig	optional configurations, includes optional metadata to attach to the shipment, and a no_notification flag.

Returns

Promise<Swap>

the updated swap with new status and fulfillments.

Defined in

packages/medusa/src/services/swap.ts:904

---

createShipment

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

Marks a fulfillment as shipped and attaches tracking numbers.

Parameters

Name	Type	Description
swapId	string	the id of the swap that has been shipped.
fulfillmentId	string	the id of the specific fulfillment that has been shipped
trackingLinks?	{ tracking_number: string }[]	the tracking numbers associated with the shipment
config	CreateShipmentConfig	optional configurations, includes optional metadata to attach to the shipment, and a noNotification flag.

Returns

Promise<Swap>

the updated swap with new fulfillments and status.

Defined in

packages/medusa/src/services/swap.ts:1074

---

deleteMetadata

▸ deleteMetadata(swapId, key): Promise<Swap>

Dedicated method to delete metadata for a swap.

Parameters

Name	Type	Description
swapId	string	the order to delete metadata from.
key	string	key for metadata field

Returns

Promise<Swap>

resolves to the updated result.

Defined in

packages/medusa/src/services/swap.ts:1152

---

list

▸ list(selector, config?): Promise<Swap[]>

List swaps.

Parameters

Name	Type	Description
selector	Selector<Swap>	the query object for find
config	FindConfig<Swap>	the configuration used to find the objects. contains relations, skip, and take.

Returns

Promise<Swap[]>

the result of the find operation

Defined in

packages/medusa/src/services/swap.ts:287

---

processDifference

▸ processDifference(swapId): Promise<Swap>

Process difference for the requested swap.

Parameters

Name	Type	Description
swapId	string	id of a swap being processed

Returns

Promise<Swap>

processed swap

Defined in

packages/medusa/src/services/swap.ts:415

---

registerCartCompletion

▸ registerCartCompletion(swapId): Promise<Swap>

Register a cart completion

Parameters

Name	Type	Description
swapId	string	The id of the swap

Returns

Promise<Swap>

swap related to the cart

Defined in

packages/medusa/src/services/swap.ts:709

---

registerReceived

▸ registerReceived(id): Promise<Swap>

Registers the swap return items as received so that they cannot be used as a part of other swaps/returns.

Parameters

Name	Type	Description
id	any	the id of the order with the swap.

Returns

Promise<Swap>

the resulting order

Defined in

packages/medusa/src/services/swap.ts:1192

---

retrieve

▸ retrieve(swapId, config?): Promise<Swap>

Retrieves a swap with the given id.

Parameters

Name	Type	Description
swapId	string	the id of the swap to retrieve
config	Omit<FindConfig<Swap>, "select"> & { select?: string[] }	the configuration to retrieve the swap

Returns

Promise<Swap>

the swap

Defined in

packages/medusa/src/services/swap.ts:211

---

retrieveByCartId

▸ retrieveByCartId(cartId, relations?): Promise<Swap>

Retrieves a swap based on its associated cart id

Parameters

Name	Type	Default value	Description
cartId	string	undefined	the cart id that the swap's cart has
relations	undefined | string[]	[]	the relations to retrieve swap

Returns

Promise<Swap>

the swap

Defined in

packages/medusa/src/services/swap.ts:260

---

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

---

transformQueryForCart

▸ Protected transformQueryForCart(config): Omit<FindConfig<Swap>, "select"> & { select?: string[] } & { cartRelations: undefined | string[] ; cartSelects: undefined | keyof Cart[] }

Transform find config object for retrieval.

Parameters

Name	Type	Description
config	Omit<FindConfig<Swap>, "select"> & { select?: string[] }	parsed swap find config

Returns

Omit<FindConfig<Swap>, "select"> & { select?: string[] } & { cartRelations: undefined | string[] ; cartSelects: undefined | keyof Cart[] }

transformed find swap config

Defined in

packages/medusa/src/services/swap.ts:138

---

update

▸ update(swapId, update): Promise<Swap>

Update the swap record.

Parameters

Name	Type	Description
swapId	string	id of a swap to update
update	Partial<Swap>	new data

Returns

Promise<Swap>

updated swap record

Defined in

packages/medusa/src/services/swap.ts:538

---

withTransaction

▸ withTransaction(transactionManager?): SwapService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

SwapService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:14