Get Started
Product
Resources
Tools & SDKs
Framework
Reference

createReturns - Order Module Reference

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

createReturns(data, sharedContext?): Promise<ReturnDTO>#

This method creates a return.

Example#

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

Parameters#

dataCreateOrderReturnDTO

The return to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<ReturnDTO>

The created return.

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

This method creates returns.

Example#

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

Parameters#

dataCreateOrderReturnDTO[]

The returns to be created.

sharedContextContextOptional

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

Returns#

PromisePromise<ReturnDTO[]>

The created returns.

Was this page helpful?