Get Started
Product
Resources
Tools & SDKs
Framework
Reference

receiveReturn - Order Module Reference

This documentation provides a reference to the receiveReturn 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 marks a return as received, changing its status to received.

Example#

Code
1const orderReturn = await orderModuleService.receiveReturn({2  return_id: "123",3  items: [4    {5      id: "123",6      quantity:17    }8  ]9})

Parameters#

returnDataReceiveOrderReturnDTO

The receival details.

sharedContextContextOptional

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

Returns#

PromisePromise<ReturnDTO>

The received return.

Was this page helpful?