confirmOrderChange - Order Module Reference

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

confirmOrderChange(orderChangeId, sharedContext?): Promise<OrderChangeReturn>#

This method confirms an order change, applying these changes on the associated order.

Code
1const {2  items,3  shippingMethods4} =  await orderModuleService.confirmOrderChange("123")

orderChangeIdstring

The order change's ID.

sharedContextContextOptional

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

PromisePromise<OrderChangeReturn>

The item and shipping method changes made on the order.

This method confirms order changes, applying these changes on the associated orders.

Code
await orderModuleService.confirmOrderChange(["123"])

orderChangeIdstring[]

The order changes' IDs.

sharedContextContextOptional

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

PromisePromise<OrderChangeReturn>

The item and shipping method changes made on the order.

This method confirms an order change, specifying confirmation details.

Code
1await orderModuleService.confirmOrderChange({2  id: "123",3  confirmed_by: "user_123"4})

The confirmation's details of the order change.

sharedContextContextOptional

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

PromisePromise<OrderChangeReturn>

The item and shipping method changes made on the order.

This method confirms order changes, specifying confirmation details.

Code
1await orderModuleService.confirmOrderChange([{2  id: "123",3  confirmed_by: "user_123"4}])

The confirm order changes details.

sharedContextContextOptional

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

PromisePromise<OrderChangeReturn>

The item and shipping method changes made on all the orders.