Skip to main content

Class: ReturnService

Hierarchy

  • TransactionBaseServiceCopy to Clipboard

    ReturnServiceCopy to Clipboard

Constructors

constructor

new ReturnService(__namedParametersCopy to Clipboard)

Parameters

NameType
__namedParametersCopy to ClipboardInjectedDependenciesCopy to Clipboard

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/return.ts:67

Properties

__configModule__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __configModule__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__configModule__

Defined in

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


__container__

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard __container__: anyCopy to Clipboard

Inherited from

TransactionBaseService.__container__

Defined in

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


__moduleDeclaration__

ProtectedCopy to Clipboard OptionalCopy to Clipboard ReadonlyCopy to Clipboard __moduleDeclaration__: RecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard>

Inherited from

TransactionBaseService.__moduleDeclaration__

Defined in

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


fulfillmentProviderService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard fulfillmentProviderService_: FulfillmentProviderServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:61


lineItemService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard lineItemService_: LineItemServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:58


manager_

ProtectedCopy to Clipboard manager_: EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/return.ts:52


orderService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard orderService_: OrderServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:63


productVariantInventoryService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard productVariantInventoryService_: ProductVariantInventoryServiceCopy to Clipboard

Defined in

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


returnItemRepository_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard returnItemRepository_: typeof ReturnItemRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:57


returnReasonService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard returnReasonService_: ReturnReasonServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:62


returnRepository_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard returnRepository_: typeof ReturnRepositoryCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:56


shippingOptionService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard shippingOptionService_: ShippingOptionServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:60


taxProviderService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard taxProviderService_: TaxProviderServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:59


totalsService_

ProtectedCopy to Clipboard ReadonlyCopy to Clipboard totalsService_: TotalsServiceCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:55


transactionManager_

ProtectedCopy to Clipboard transactionManager_: undefinedCopy to Clipboard | EntityManagerCopy to Clipboard

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/return.ts:53

Methods

atomicPhase_

ProtectedCopy to Clipboard atomicPhase_<TResultCopy to Clipboard, TErrorCopy to Clipboard>(workCopy to Clipboard, isolationOrErrorHandler?Copy to Clipboard, maybeErrorHandlerOrDontFail?Copy to Clipboard): PromiseCopy to Clipboard<TResultCopy to Clipboard>

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
TResultCopy to Clipboard
TErrorCopy to Clipboard

Parameters

NameTypeDescription
workCopy to Clipboard(transactionManagerCopy to Clipboard: EntityManagerCopy to Clipboard) => PromiseCopy to Clipboard<TResultCopy to Clipboard>the transactional work to be done
isolationOrErrorHandler?Copy to ClipboardIsolationLevelCopy to Clipboard | (errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail?Copy to Clipboard(errorCopy to Clipboard: TErrorCopy to Clipboard) => PromiseCopy to Clipboard<voidCopy to Clipboard | TResultCopy to Clipboard>Potential error handler

Returns

PromiseCopy to Clipboard<TResultCopy to Clipboard>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

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


cancel

cancel(returnIdCopy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Cancels a return if possible. Returns can be canceled if it has not been received.

Parameters

NameTypeDescription
returnIdCopy to ClipboardstringCopy to Clipboardthe id of the return to cancel.

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

the updated Return

Defined in

packages/medusa/src/services/return.ts:164


create

create(dataCopy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Creates a return request for an order, with given items, and a shipping method. If no refund amount is provided the refund amount is calculated from the return lines and the shipping cost.

Parameters

NameTypeDescription
dataCopy to ClipboardCreateReturnInputCopy to Clipboarddata to use for the return e.g. shipping_method, items or refund_amount

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

the created return

Defined in

packages/medusa/src/services/return.ts:349


fulfill

fulfill(returnIdCopy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Parameters

NameType
returnIdCopy to ClipboardstringCopy to Clipboard

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Defined in

packages/medusa/src/services/return.ts:495


getFulfillmentItems

ProtectedCopy to Clipboard getFulfillmentItems(orderCopy to Clipboard, itemsCopy to Clipboard, transformerCopy to Clipboard): PromiseCopy to Clipboard<LineItemCopy to Clipboard & { note?Copy to Clipboard: stringCopy to Clipboard ; reason_id?Copy to Clipboard: stringCopy to Clipboard }[]>

Retrieves the order line items, given an array of items

Parameters

NameTypeDescription
orderCopy to ClipboardOrderCopy to Clipboardthe order to get line items from
itemsCopy to ClipboardOrdersReturnItemCopy to Clipboard[]the items to get
transformerCopy to ClipboardTransformerCopy to Clipboarda function to apply to each of the items retrieved from the order, should return a line item. If the transformer returns an undefined value the line item will be filtered from the returned array.

Returns

PromiseCopy to Clipboard<LineItemCopy to Clipboard & { note?Copy to Clipboard: stringCopy to Clipboard ; reason_id?Copy to Clipboard: stringCopy to Clipboard }[]>

the line items generated by the transformer.

Defined in

packages/medusa/src/services/return.ts:106


list

list(selectorCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard[]>

Parameters

NameTypeDescription
selectorCopy to ClipboardSelectorCopy to Clipboard<ReturnCopy to Clipboard>the query object for find
configCopy to ClipboardFindConfigCopy to Clipboard<ReturnCopy to Clipboard>the config object for find

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard[]>

the result of the find operation

Defined in

packages/medusa/src/services/return.ts:146


receive

receive(returnIdCopy to Clipboard, receivedItemsCopy to Clipboard, refundAmount?Copy to Clipboard, allowMismatch?Copy to Clipboard, context?Copy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Registers a previously requested return as received. This will create a refund to the customer. If the returned items don't match the requested items the return status will be updated to requires_action. This behaviour is useful in sitautions where a custom refund amount is requested, but the retuned items are not matching the requested items. Setting the allowMismatch argument to true, will process the return, ignoring any mismatches.

Parameters

NameTypeDefault valueDescription
returnIdCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboardthe orderId to return to
receivedItemsCopy to ClipboardOrdersReturnItemCopy to Clipboard[]undefinedCopy to Clipboardthe items received after return.
refundAmount?Copy to ClipboardnumberCopy to ClipboardundefinedCopy to Clipboardthe amount to return
allowMismatchCopy to ClipboardbooleanCopy to ClipboardfalseCopy to Clipboardwhether to ignore return/received product mismatch
contextCopy to ClipboardObjectCopy to Clipboard{}Copy to Clipboard-
context.locationId?Copy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard-

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

the result of the update operation

Defined in

packages/medusa/src/services/return.ts:566


retrieve

retrieve(returnIdCopy to Clipboard, config?Copy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Retrieves a return by its id.

Parameters

NameTypeDescription
returnIdCopy to ClipboardstringCopy to Clipboardthe id of the return to retrieve
configCopy to ClipboardFindConfigCopy to Clipboard<ReturnCopy to Clipboard>the config object

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

the return

Defined in

packages/medusa/src/services/return.ts:262


retrieveBySwap

retrieveBySwap(swapIdCopy to Clipboard, relations?Copy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Parameters

NameTypeDefault value
swapIdCopy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard
relationsCopy to ClipboardstringCopy to Clipboard[][]Copy to Clipboard

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Defined in

packages/medusa/src/services/return.ts:290


shouldRetryTransaction_

ProtectedCopy to Clipboard shouldRetryTransaction_(errCopy to Clipboard): booleanCopy to Clipboard

Parameters

NameType
errCopy to ClipboardRecordCopy to Clipboard<stringCopy to Clipboard, unknownCopy to Clipboard> | { codeCopy to Clipboard: stringCopy to Clipboard }

Returns

booleanCopy to Clipboard

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

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


update

update(returnIdCopy to Clipboard, updateCopy to Clipboard): PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Parameters

NameType
returnIdCopy to ClipboardstringCopy to Clipboard
updateCopy to ClipboardUpdateReturnInputCopy to Clipboard

Returns

PromiseCopy to Clipboard<ReturnCopy to Clipboard>

Defined in

packages/medusa/src/services/return.ts:315


validateReturnLineItem

ProtectedCopy to Clipboard validateReturnLineItem(item?Copy to Clipboard, quantity?Copy to Clipboard, additional?Copy to Clipboard): ObjectCopy to Clipboard

Checks that a given quantity of a line item can be returned. Fails if the item is undefined or if the returnable quantity of the item is lower, than the quantity that is requested to be returned.

Parameters

NameTypeDefault valueDescription
item?Copy to ClipboardLineItemCopy to ClipboardundefinedCopy to Clipboardthe line item to check has sufficient returnable quantity.
quantityCopy to ClipboardnumberCopy to Clipboard0Copy to Clipboardthe quantity that is requested to be returned.
additionalCopy to ClipboardObjectCopy to Clipboard{}Copy to Clipboardthe quantity that is requested to be returned.
additional.note?Copy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard-
additional.reason_id?Copy to ClipboardstringCopy to ClipboardundefinedCopy to Clipboard-

Returns

ObjectCopy to Clipboard

a line item where the quantity is set to the requested return quantity.

NameType
adjustments?Copy to Clipboard(undefinedCopy to Clipboard | { id?: string | undefined; item_id?: string | undefined; item?: { cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; ... 37 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 38 more ...; updated_at?: { ...; }...)[]
allow_discounts?Copy to ClipboardbooleanCopy to Clipboard
cart?Copy to Clipboard{ readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; billing_address?: { customer_id?: string | null | undefined; customer?: { ...; } | ... 1 more ... | undefined; ... 15 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 36 more ...; updated_at?: ...
cart_id?Copy to ClipboardstringCopy to Clipboard
claim_order?Copy to Clipboard{ payment_status?: ClaimPaymentStatus | undefined; fulfillment_status?: ClaimFulfillmentStatus | undefined; claim_items?: ({ images?: ({ ...; } | undefined)[] | undefined; ... 14 more ...; updated_at?: { ...; } | undefined; } | undefined)[] | undefined; ... 17 more ...; id?: string | undefined; }
claim_order_id?Copy to ClipboardstringCopy to Clipboard
created_at?Copy to Clipboard{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
description?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard
discount_total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
fulfilled_quantity?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
gift_card_total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
has_shipping?Copy to ClipboardnullCopy to Clipboard | booleanCopy to Clipboard
id?Copy to ClipboardstringCopy to Clipboard
includes_tax?Copy to ClipboardbooleanCopy to Clipboard
is_giftcard?Copy to ClipboardbooleanCopy to Clipboard
is_return?Copy to ClipboardbooleanCopy to Clipboard
metadata?Copy to Clipboard{ [x: string]: unknown; }
order?Copy to Clipboard{ readonly object?: "order" | undefined; status?: OrderStatus | undefined; fulfillment_status?: FulfillmentStatus | undefined; payment_status?: PaymentStatus | undefined; ... 49 more ...; updated_at?: { ...; } | undefined; }
order_edit?Copy to ClipboardnullCopy to Clipboard | { order_id?: string | undefined; order?: { readonly object?: "order" | undefined; status?: OrderStatus | undefined; fulfillment_status?: FulfillmentStatus | undefined; ... 50 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 27 more ...; updated_at?: { ...; } | undefined; }
order_edit_id?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard
order_id?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard
original_item_id?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard
original_tax_total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
original_total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
quantity?Copy to ClipboardnumberCopy to Clipboard
refundable?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
returned_quantity?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
shipped_quantity?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
should_merge?Copy to ClipboardbooleanCopy to Clipboard
subtotal?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
swap?Copy to Clipboard{ fulfillment_status?: SwapFulfillmentStatus | undefined; payment_status?: SwapPaymentStatus | undefined; order_id?: string | undefined; ... 20 more ...; updated_at?: { ...; } | undefined; }
swap_id?Copy to ClipboardstringCopy to Clipboard
tax_lines?Copy to Clipboard(undefinedCopy to Clipboard | { item_id?: string | undefined; item?: { cart_id?: string | undefined; cart?: { readonly object?: "cart" | undefined; email?: string | undefined; billing_address_id?: string | undefined; ... 37 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 38 more ...; updated_at?: { ...; } | undefined; } | undefin...)[]
tax_total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
thumbnail?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard
title?Copy to ClipboardstringCopy to Clipboard
total?Copy to ClipboardnullCopy to Clipboard | numberCopy to Clipboard
unit_price?Copy to ClipboardnumberCopy to Clipboard
updated_at?Copy to Clipboard{ toString?: {} | undefined; toDateString?: {} | undefined; toTimeString?: {} | undefined; toLocaleString?: {} | undefined; toLocaleDateString?: {} | undefined; toLocaleTimeString?: {} | undefined; ... 37 more ...; [Symbol.toPrimitive]?: {} | undefined; }
variant?Copy to Clipboard{ title?: string | undefined; product_id?: string | undefined; product?: { title?: string | undefined; subtitle?: string | null | undefined; description?: string | null | undefined; ... 30 more ...; updated_at?: { ...; } | undefined; } | undefined; ... 23 more ...; updated_at?: { ...; } | undefined; }
variant_id?Copy to ClipboardnullCopy to Clipboard | stringCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:220


validateReturnStatuses

ProtectedCopy to Clipboard validateReturnStatuses(orderCopy to Clipboard): voidCopy to Clipboard

Checks that an order has the statuses necessary to complete a return. fulfillment_status cannot be not_fulfilled or returned. payment_status must be captured.

ThrowsCopy to Clipboard

when statuses are not sufficient for returns.

Parameters

NameTypeDescription
orderCopy to ClipboardOrderCopy to Clipboardthe order to check statuses on

Returns

voidCopy to Clipboard

Defined in

packages/medusa/src/services/return.ts:190


withTransaction

withTransaction(transactionManager?Copy to Clipboard): ReturnServiceCopy to Clipboard

Parameters

NameType
transactionManager?Copy to ClipboardEntityManagerCopy to Clipboard

Returns

ReturnServiceCopy to Clipboard

Inherited from

TransactionBaseService.withTransaction

Defined in

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