updateReturns - Order Module Reference

This documentation provides a reference to the updateReturns 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.

updateReturns(data, sharedContext?): Promise<ReturnDTO[]>#

This method updates existing returns.

Code
1const returns = await orderModuleService.updateReturns([{2  selector: {3    id: "123"4  },5  data: {6    refund_amount: 107  }8}])

The filters specifying which returns to update, and the data to update in them.

sharedContextContextOptional

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

PromisePromise<ReturnDTO[]>

The updated returns.

This method updates existing returns matching the specified filters.

Code
1const returns = await orderModuleService.updateReturns({2  id: "123"3}, {4  refund_amount: 105})

The filters specifying which returns to update.

The data to update in the returns.

sharedContextContextOptional

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

PromisePromise<ReturnDTO[]>

The updated returns.

This method updates an existing return.

Code
1const orderReturn = await orderModuleService.updateReturns(2  "123",3  {4    refund_amount: 105  }6)

idstring

The ID of the return.

The data to update.

sharedContextContextOptional

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

PromisePromise<ReturnDTO>

The updated return.

Was this page helpful?