declineOrderChange - Order Module Reference

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

declineOrderChange(orderChangeId, sharedContext?): Promise<void>#

This method declines an order change.

Code
await orderModuleService.declineOrderChange("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<void>

Resolves when the order change is declined successfully.

This method declines order changes.

Code
await orderModuleService.declineOrderChange(["123", "321"])

orderChangeIdstring[]

The order changes' IDs.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the order changes are declined successfully.

This method declines an order change, providing additional details.

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

The details of the order change decline.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the order change is declined successfully.

This method declines order changes, providing additional details for each.

Code
1await orderModuleService.declineOrderChange([2  {3    id: "123",4    declined_by: "user_123"5  }6])

The details of the order change declines.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the order changes are declined successfully.

Was this page helpful?