ccrz.ccApiOrder.cancel

Compatibility

This reference applies to:

Signature

global static Map<String, Object> cancel(Map<String, Object>)

Service Layer Classes

Logic Service Provider

ccrz.ccLogicOrderCancel

Inputs (Required)

Map<String, Object> that must include the following required keys:

ccrz.ccApi.API_VERSION

The version of the B2B Commerce for Visualforce API to reference for the method call. We recommend that you use the ccrz.ccApi.CURRENT_VERSION constant whenever possible, and only reference a specific version for compatibility if necessary.

If this key isn't specified, the method returns a ccrz.ccApi.NoApiVersionException.

Note

Include one of the following keys. If none of these keys are included, the method returns a ccrz.ccApi.MissingInputException.

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

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING

Map<String, Object> that describes options for sizing and scoping the method's return data. This method supports ccrz.ccApi.SZ_REFETCH => TRUE, which specifies that this method invokes ccrz.ccApiOrder.fetch for returning the canceled order.

ccrz.ccApi.SIZING => new Map<String, Object>{
    ccrz.ccApiOrder.ENTITYNAME => new Map<String, Object>{
        ccrz.ccApi.SZ_REFETCH => TRUE
    }
}

Outputs

Map<String, Object> that can include the following keys:

ccrz.ccApi.API_VERSION

Integer that indicates which API version was used for the query.

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 canceled ccrz__E_Order__c record.

This key is returned only when the input map includes ccrz.ccApi.SZ_REFETCH => true.

Note