retrieveReturnReason - Order Module Reference

This documentation provides a reference to the retrieveReturnReason method. This belongs to the Order Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

This method retrieves a return reason by its ID.

Example#

A simple example that retrieves a return reason by its ID:

Code
1const returnReason = await orderModuleService.retrieveReturnReason(2  "123"3)

To specify relations that should be retrieved:

Note: You can only retrieve data models defined in the same module. To retrieve linked data models from other modules, use Query instead.

Code
1const returnReason = await orderModuleService.retrieveReturnReason(2  "123",3  {4    relations: ["parent_return_reason"]5  }6)

Parameters#

reasonIdstring

The return reason's ID.

configFindConfig<OrderReturnReasonDTO>Optional

The configurations determining how the return reason is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a return reason.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<OrderReturnReasonDTO>

The retrieved return reason.