ccrz.ccApiOrder.getOrdersToSplit

Determines which orders to include in the ccrz.ccSplitOrderJob batch processing class. By default, this method includes all orders where the ccrz__SplitProcessed__c field is FALSE.

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

You can still call older versions of the API for this method, which can accept different input keys or return different output keys. Any differences in behavior for older versions aren't documented in this topic.

Note

Signature

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

Service Layer Classes

Logic Service Provider
ccrz.ccLogicOrderGetOrdersToSplit

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

ccrz.ccApiOrder.PARAM_STOREFRONT
String that specifies the name of the storefront to split orders for.

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

Note

Outputs

Map<String, Object> that can include 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.SPLITSELECTOR
QueryLocator for the ccrz.ccSplitOrderJob batch processing class to execute against.