Class: ReturnService
Hierarchy
TransactionBaseService
Copy to Clipboard↳
ReturnService
Copy to Clipboard
Constructors
constructor
• new ReturnService(__namedParameters
Copy to Clipboard)
Parameters
Name | Type |
---|---|
__namedParameters Copy to Clipboard | InjectedDependencies Copy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/return.ts:67
Properties
__configModule__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __configModule__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected
Copy to Clipboard Readonly
Copy to Clipboard __container__: any
Copy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __moduleDeclaration__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
fulfillmentProviderService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard fulfillmentProviderService_: FulfillmentProviderService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:61
lineItemService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard lineItemService_: LineItemService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:58
manager_
• Protected
Copy to Clipboard manager_: EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/return.ts:52
orderService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard orderService_: OrderService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:63
productVariantInventoryService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard productVariantInventoryService_: ProductVariantInventoryService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:65
returnItemRepository_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard returnItemRepository_: typeof ReturnItemRepository
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:57
returnReasonService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard returnReasonService_: ReturnReasonService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:62
returnRepository_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard returnRepository_: typeof ReturnRepository
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:56
shippingOptionService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard shippingOptionService_: ShippingOptionService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:60
taxProviderService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard taxProviderService_: TaxProviderService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:59
totalsService_
• Protected
Copy to Clipboard Readonly
Copy to Clipboard totalsService_: TotalsService
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:55
transactionManager_
• Protected
Copy to Clipboard transactionManager_: undefined
Copy to Clipboard | EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/return.ts:53
Methods
atomicPhase_
▸ Protected
Copy to Clipboard atomicPhase_<TResult
Copy to Clipboard, TError
Copy to Clipboard>(work
Copy to Clipboard, isolationOrErrorHandler?
Copy to Clipboard, maybeErrorHandlerOrDontFail?
Copy to Clipboard): Promise
Copy to Clipboard<TResult
Copy 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 |
---|
TResult Copy to Clipboard |
TError Copy to Clipboard |
Parameters
Name | Type | Description |
---|---|---|
work Copy to Clipboard | (transactionManager Copy to Clipboard: EntityManager Copy to Clipboard) => Promise Copy to Clipboard<TResult Copy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler? Copy to Clipboard | IsolationLevel Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | Potential error handler |
Returns
Promise
Copy to Clipboard<TResult
Copy 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(returnId
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard>
Cancels a return if possible. Returns can be canceled if it has not been received.
Parameters
Name | Type | Description |
---|---|---|
returnId Copy to Clipboard | string Copy to Clipboard | the id of the return to cancel. |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
the updated Return
Defined in
packages/medusa/src/services/return.ts:164
create
▸ create(data
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy 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
Name | Type | Description |
---|---|---|
data Copy to Clipboard | CreateReturnInput Copy to Clipboard | data to use for the return e.g. shipping_method, items or refund_amount |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
the created return
Defined in
packages/medusa/src/services/return.ts:349
fulfill
▸ fulfill(returnId
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard>
Parameters
Name | Type |
---|---|
returnId Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
Defined in
packages/medusa/src/services/return.ts:495
getFulfillmentItems
▸ Protected
Copy to Clipboard getFulfillmentItems(order
Copy to Clipboard, items
Copy to Clipboard, transformer
Copy to Clipboard): Promise
Copy to Clipboard<LineItem
Copy to Clipboard & { note?
Copy to Clipboard: string
Copy to Clipboard ; reason_id?
Copy to Clipboard: string
Copy to Clipboard }[]>
Retrieves the order line items, given an array of items
Parameters
Name | Type | Description |
---|---|---|
order Copy to Clipboard | Order Copy to Clipboard | the order to get line items from |
items Copy to Clipboard | OrdersReturnItem Copy to Clipboard[] | the items to get |
transformer Copy to Clipboard | Transformer Copy to Clipboard | a 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
Promise
Copy to Clipboard<LineItem
Copy to Clipboard & { note?
Copy to Clipboard: string
Copy to Clipboard ; reason_id?
Copy to Clipboard: string
Copy to Clipboard }[]>
the line items generated by the transformer.
Defined in
packages/medusa/src/services/return.ts:106
list
▸ list(selector
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard[]>
Parameters
Name | Type | Description |
---|---|---|
selector Copy to Clipboard | Selector Copy to Clipboard<Return Copy to Clipboard> | the query object for find |
config Copy to Clipboard | FindConfig Copy to Clipboard<Return Copy to Clipboard> | the config object for find |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard[]>
the result of the find operation
Defined in
packages/medusa/src/services/return.ts:146
receive
▸ receive(returnId
Copy to Clipboard, receivedItems
Copy to Clipboard, refundAmount?
Copy to Clipboard, allowMismatch?
Copy to Clipboard, context?
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy 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
Name | Type | Default value | Description |
---|---|---|---|
returnId Copy to Clipboard | string Copy to Clipboard | undefined Copy to Clipboard | the orderId to return to |
receivedItems Copy to Clipboard | OrdersReturnItem Copy to Clipboard[] | undefined Copy to Clipboard | the items received after return. |
refundAmount? Copy to Clipboard | number Copy to Clipboard | undefined Copy to Clipboard | the amount to return |
allowMismatch Copy to Clipboard | boolean Copy to Clipboard | false Copy to Clipboard | whether to ignore return/received product mismatch |
context Copy to Clipboard | Object Copy to Clipboard | {} Copy to Clipboard | - |
context.locationId? Copy to Clipboard | string Copy to Clipboard | undefined Copy to Clipboard | - |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
the result of the update operation
Defined in
packages/medusa/src/services/return.ts:566
retrieve
▸ retrieve(returnId
Copy to Clipboard, config?
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard>
Retrieves a return by its id.
Parameters
Name | Type | Description |
---|---|---|
returnId Copy to Clipboard | string Copy to Clipboard | the id of the return to retrieve |
config Copy to Clipboard | FindConfig Copy to Clipboard<Return Copy to Clipboard> | the config object |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
the return
Defined in
packages/medusa/src/services/return.ts:262
retrieveBySwap
▸ retrieveBySwap(swapId
Copy to Clipboard, relations?
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard>
Parameters
Name | Type | Default value |
---|---|---|
swapId Copy to Clipboard | string Copy to Clipboard | undefined Copy to Clipboard |
relations Copy to Clipboard | string Copy to Clipboard[] | [] Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
Defined in
packages/medusa/src/services/return.ts:290
shouldRetryTransaction_
▸ Protected
Copy to Clipboard shouldRetryTransaction_(err
Copy to Clipboard): boolean
Copy to Clipboard
Parameters
Name | Type |
---|---|
err Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, unknown Copy to Clipboard> | { code Copy to Clipboard: string Copy to Clipboard } |
Returns
boolean
Copy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(returnId
Copy to Clipboard, update
Copy to Clipboard): Promise
Copy to Clipboard<Return
Copy to Clipboard>
Parameters
Name | Type |
---|---|
returnId Copy to Clipboard | string Copy to Clipboard |
update Copy to Clipboard | UpdateReturnInput Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Return
Copy to Clipboard>
Defined in
packages/medusa/src/services/return.ts:315
validateReturnLineItem
▸ Protected
Copy to Clipboard validateReturnLineItem(item?
Copy to Clipboard, quantity?
Copy to Clipboard, additional?
Copy to Clipboard): Object
Copy 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
Name | Type | Default value | Description |
---|---|---|---|
item? Copy to Clipboard | LineItem Copy to Clipboard | undefined Copy to Clipboard | the line item to check has sufficient returnable quantity. |
quantity Copy to Clipboard | number Copy to Clipboard | 0 Copy to Clipboard | the quantity that is requested to be returned. |
additional Copy to Clipboard | Object Copy to Clipboard | {} Copy to Clipboard | the quantity that is requested to be returned. |
additional.note? Copy to Clipboard | string Copy to Clipboard | undefined Copy to Clipboard | - |
additional.reason_id? Copy to Clipboard | string Copy to Clipboard | undefined Copy to Clipboard | - |
Returns
Object
Copy to Clipboard
a line item where the quantity is set to the requested return quantity.
Name | Type |
---|---|
adjustments? Copy to Clipboard | (undefined Copy 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 Clipboard | boolean Copy 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 Clipboard | string Copy 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 Clipboard | string Copy 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 Clipboard | null Copy to Clipboard | string Copy to Clipboard |
discount_total? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
fulfilled_quantity? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
gift_card_total? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
has_shipping? Copy to Clipboard | null Copy to Clipboard | boolean Copy to Clipboard |
id? Copy to Clipboard | string Copy to Clipboard |
includes_tax? Copy to Clipboard | boolean Copy to Clipboard |
is_giftcard? Copy to Clipboard | boolean Copy to Clipboard |
is_return? Copy to Clipboard | boolean Copy 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 Clipboard | null Copy 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 Clipboard | null Copy to Clipboard | string Copy to Clipboard |
order_id? Copy to Clipboard | null Copy to Clipboard | string Copy to Clipboard |
original_item_id? Copy to Clipboard | null Copy to Clipboard | string Copy to Clipboard |
original_tax_total? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
original_total? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
quantity? Copy to Clipboard | number Copy to Clipboard |
refundable? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
returned_quantity? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
shipped_quantity? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
should_merge? Copy to Clipboard | boolean Copy to Clipboard |
subtotal? Copy to Clipboard | null Copy to Clipboard | number Copy 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 Clipboard | string Copy to Clipboard |
tax_lines? Copy to Clipboard | (undefined Copy 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 Clipboard | null Copy to Clipboard | number Copy to Clipboard |
thumbnail? Copy to Clipboard | null Copy to Clipboard | string Copy to Clipboard |
title? Copy to Clipboard | string Copy to Clipboard |
total? Copy to Clipboard | null Copy to Clipboard | number Copy to Clipboard |
unit_price? Copy to Clipboard | number Copy 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 Clipboard | null Copy to Clipboard | string Copy to Clipboard |
Defined in
packages/medusa/src/services/return.ts:220
validateReturnStatuses
▸ Protected
Copy to Clipboard validateReturnStatuses(order
Copy to Clipboard): void
Copy 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.
Throws
Copy to Clipboard
when statuses are not sufficient for returns.
Parameters
Name | Type | Description |
---|---|---|
order Copy to Clipboard | Order Copy to Clipboard | the order to check statuses on |
Returns
void
Copy to Clipboard
Defined in
packages/medusa/src/services/return.ts:190
withTransaction
▸ withTransaction(transactionManager?
Copy to Clipboard): ReturnService
Copy to Clipboard
Parameters
Name | Type |
---|---|
transactionManager? Copy to Clipboard | EntityManager Copy to Clipboard |
Returns
ReturnService
Copy to Clipboard
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14