ccrz.ccLogicOrderCancel.fetchOrder

Compatibility

This reference applies to:

Signature

global virtual Map<String, Object> fetchOrder(Map<String, Object>)

Inputs (Required)

This method accepts the Map<String, Object> from the ccrz.ccLogicOrderCancel.processInput method.

This method executes only if the working map includes one of the following keys:

ccrz.ccApiOrder.PARAM_ORDER_ENCID

Encrypted ID of the order to cancel.

ccrz.ccApiOrder.PARAM_ORDER_ENCID_LIST

Set<String> that includes the encrypted ID of only one order to cancel.

Even though this key specifies a set, the method evaluates only the first ID in the set.

Note

ccrz.ccApiOrder.PARAM_ORDER_ID

Salesforce ID of the order to cancel.

ccrz.ccApiOrder.PARAM_ORDER_ID_LIST

Set<String> that includes the Salesforce ID of only one order to cancel.

Even though this key specifies a set, the method evaluates only the first ID in the set.

Note

Logic Performed

This method completes the following actions:

1. Calls the ccrz.ccApiOrder.fetch method to query order records.
2. Calls the ccrz.ccApiOrder.canCancel to determine whether the order is eligible for cancellation.
3. If the order is eligible for cancellation, sets the order's ccrz__OrderStatus__c field to Cancelled.

Outputs

This method returns the working Map<String, Object>, and sets the following keys:

ccrz.ccApi.SUCCESS

Boolean

Value	Usage
true	The call completed.
false	The call encountered errors. B2B Commerce for Visualforce doesn't always return an exception for any errors that can occur. When this value is false, consider rolling back the API transaction to a previous savepoint. Tip

ccrz.ccApiOrder.ORDERLIST

List<Map<String, Object>>, where the Map<String, Object> represents the ccrz__E_Order__c record that the ccrz.ccApiOrder.fetch method returns.