SwapService

Handles swaps

Hierarchy

• TransactionBaseService

  ↳ SwapService

Constructors

constructor

new SwapService(«destructured»)

Parameters

Name
«destructured»

Overrides

TransactionBaseService.constructor

Defined in

medusa/src/services/swap.ts:91

Properties

__configModule__

Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

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

---

__container__

Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

medusa/src/interfaces/transaction-base-service.ts:13

---

__moduleDeclaration__

Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

medusa/src/interfaces/transaction-base-service.ts:15

---

cartService_

Protected Readonly cartService_: CartService

Defined in

medusa/src/services/swap.ts:77

---

customShippingOptionService_

Protected Readonly customShippingOptionService_: CustomShippingOptionService

Defined in

medusa/src/services/swap.ts:87

---

eventBus_

Protected Readonly eventBus_: EventBusService

Defined in

medusa/src/services/swap.ts:78

---

fulfillmentService_

Protected Readonly fulfillmentService_: FulfillmentService

Defined in

medusa/src/services/swap.ts:83

---

lineItemAdjustmentService_

Protected Readonly lineItemAdjustmentService_: LineItemAdjustmentService

Defined in

medusa/src/services/swap.ts:86

---

lineItemService_

Protected Readonly lineItemService_: LineItemService

Defined in

medusa/src/services/swap.ts:82

---

manager_

Protected manager_: EntityManager

Inherited from

TransactionBaseService.manager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:5

---

orderService_

Protected Readonly orderService_: OrderService

Defined in

medusa/src/services/swap.ts:79

---

paymentProviderService_

Protected Readonly paymentProviderService_: PaymentProviderService

Defined in

medusa/src/services/swap.ts:85

---

productVariantInventoryService_

Protected Readonly productVariantInventoryService_: ProductVariantInventoryService

Defined in

medusa/src/services/swap.ts:89

---

returnService_

Protected Readonly returnService_: ReturnService

Defined in

medusa/src/services/swap.ts:80

---

shippingOptionService_

Protected Readonly shippingOptionService_: ShippingOptionService

Defined in

medusa/src/services/swap.ts:84

---

swapRepository_

Protected Readonly swapRepository_: Repository<Swap>

Defined in

medusa/src/services/swap.ts:75

---

totalsService_

Protected Readonly totalsService_: TotalsService

Defined in

medusa/src/services/swap.ts:81

---

transactionManager_

Protected transactionManager_: undefined | EntityManager

Inherited from

TransactionBaseService.transactionManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:6

---

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

medusa/src/services/swap.ts:63

Accessors

activeManager_

Protected get activeManager_(): EntityManager

Returns

EntityManager

-EntityManager:

Inherited from

TransactionBaseService.activeManager_

Defined in

medusa/src/interfaces/transaction-base-service.ts:8

Methods

areReturnItemsValid

Protected areReturnItemsValid(returnItems): Promise<boolean>

Parameters

Name
returnItems

Returns

Promise<boolean>

-Promise: -boolean: (optional)

Defined in

medusa/src/services/swap.ts:1240

---

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.

Name
TResult
TError

Parameters

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

Returns

Promise<TResult>

-Promise: the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

medusa/src/interfaces/transaction-base-service.ts:56

---

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	Description
swapId	string

Returns

Promise<Swap>

-Promise: the canceled swap. -Swap:

Defined in

medusa/src/services/swap.ts:857

---

cancelFulfillment

cancelFulfillment(fulfillmentId): Promise<Swap>

Cancels a fulfillment (if related to a swap)

Parameters

Name	Description
fulfillmentId	string

Returns

Promise<Swap>

-Promise: updated swap -Swap:

Defined in

medusa/src/services/swap.ts:1059

---

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	Description
order	Order
returnItems	WithRequiredProperty<Partial<ReturnItem>, "item_id">[]
additionalItems?	Pick<LineItem, "variant_id" | "quantity">[]
returnShipping?	object
returnShipping.option_id	string
returnShipping.price?	number
custom	object
custom.allow_backorder?	boolean
custom.idempotency_key?	string
custom.location_id?	string
custom.no_notification?	boolean

Returns

Promise<Swap>

-Promise: the newly created swap -Swap:

Defined in

medusa/src/services/swap.ts:321

---

createCart

createCart(swapId, customShippingOptions?, context?): 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	Default value	Description
swapId	string	the id of the swap to create the cart from
customShippingOptions	{ option_id: string ; price: number }[]	[]
context	object
context.sales_channel_id?	string

Returns

Promise<Swap>

-Promise: the swap with its cart_id prop set to the id of the new cart. -Swap:

Defined in

medusa/src/services/swap.ts:577

---

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	Description
swapId	string
config	CreateShipmentConfig

Returns

Promise<Swap>

-Promise: the updated swap with new status and fulfillments. -Swap:

Defined in

medusa/src/services/swap.ts:919

---

createShipment

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

Marks a fulfillment as shipped and attaches tracking numbers.

Parameters

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

Returns

Promise<Swap>

-Promise: the updated swap with new fulfillments and status. -Swap:

Defined in

medusa/src/services/swap.ts:1090

---

deleteMetadata

deleteMetadata(swapId, key): Promise<Swap>

Dedicated method to delete metadata for a swap.

Parameters

Name	Description
swapId	string
key	string

Returns

Promise<Swap>

-Promise: resolves to the updated result. -Swap:

Defined in

medusa/src/services/swap.ts:1168

---

list

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

List swaps.

Parameters

Name	Description
selector	Selector<Swap>
config	FindConfig<Swap>

Returns

Promise<Swap[]>

-Promise: the result of the find operation -Swap[]: -Swap:

Defined in

medusa/src/services/swap.ts:273

---

listAndCount

listAndCount(selector, config?): Promise<[Swap[], number]>

List swaps.

Parameters

Name	Description
selector	Selector<Swap>
config	FindConfig<Swap>

Returns

Promise<[Swap[], number]>

-Promise: the result of the find operation -Swap[]: -number: (optional)

Defined in

medusa/src/services/swap.ts:293

---

processDifference

processDifference(swapId): Promise<Swap>

Process difference for the requested swap.

Parameters

Name	Description
swapId	string

Returns

Promise<Swap>

-Promise: processed swap -Swap:

Defined in

medusa/src/services/swap.ts:421

---

registerCartCompletion

registerCartCompletion(swapId): Promise<Swap>

Register a cart completion

Parameters

Name	Description
swapId	string

Returns

Promise<Swap>

-Promise: swap related to the cart -Swap:

Defined in

medusa/src/services/swap.ts:724

---

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	Description
id	any

Returns

Promise<Swap>

-Promise: the resulting order -Swap:

Defined in

medusa/src/services/swap.ts:1206

---

retrieve

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

Retrieves a swap with the given id.

Parameters

Name	Description
swapId	string
config	Omit<FindConfig<Swap>, "select"> & { select?: string[] }

Returns

Promise<Swap>

-Promise: the swap -Swap:

Defined in

medusa/src/services/swap.ts:203

---

retrieveByCartId

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

Retrieves a swap based on its associated cart id

Parameters

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

Returns

Promise<Swap>

-Promise: the swap -Swap:

Defined in

medusa/src/services/swap.ts:246

---

shouldRetryTransaction_

Protected shouldRetryTransaction_(err): boolean

Parameters

Name
err

Returns

boolean

-boolean: (optional)

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

medusa/src/interfaces/transaction-base-service.ts:37

---

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	Description
config	Omit<FindConfig<Swap>, "select"> & { select?: string[] }

Returns

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

-Omit`<`FindConfig`<`Swap`\>, "select"`\> & { select?: string[] } & { cartRelations: undefined\|string[] ; cartSelects: undefined\| keyofCart[] }: (optional) transformed find swap config

Defined in

medusa/src/services/swap.ts:130

---

update

update(swapId, update): Promise<Swap>

Update the swap record.

Parameters

Name	Description
swapId	string
update	Partial<Swap>

Returns

Promise<Swap>

-Promise: updated swap record -Swap:

Defined in

medusa/src/services/swap.ts:544

---

withTransaction

withTransaction(transactionManager?): SwapService

Parameters

Name
transactionManager?

Returns

SwapService

-SwapService:

Inherited from

TransactionBaseService.withTransaction

Defined in

medusa/src/interfaces/transaction-base-service.ts:20