ccrz.cc_api_OutboundOrderCancel

Implement subscriber-defined behavior for determining whether a buyer can cancel an order from the My Orders section of the My Account page.

Compatibility

This reference applies to:

Release Managed Package Version API Version
B2B Commerce for Visualforce Winter ’21 4.13 12
B2B Commerce for Visualforce Spring ’20 4.12 11
B2B Commerce for Visualforce Summer ’19 4.11 10
B2B Commerce for Visualforce Spring ’19 4.10 9
B2B Commerce for Visualforce Summer ’18 4.9 8

Extension Class Setting in CC Admin

If you extend the default version of this class, update your storefront settings in CC Admin. Select your storefront (1), and then select Orders in the Integrations section of the Storefront Settings menu (2). Update the Outbound Order Cancel API Class field (3) with your custom class name, prefixed with c., such as c.cc_example_api_OutboundOrderCancel.

Update the Outbound Order Cancel API Class field in your storefront settings

For more help with creating an extension, including considerations and conventions, see Extend a Global Extension Point Class.

Tip

Front-End Input

On the storefront, a buyer clicks Cancel on an order from the My Orders section of the My Account page. For help with configuring the shipping options on the Checkout page, see https://help.salesforce.com/articleView?id=b2b_commerce_page_my_account_my_orders.htm.

Methods

In addition to the following methods, this class defines another method, cancelOrder, that is deprecated. Instead, use the ccrz.ccApiOrder.cancel global API method.

Note