ccrz.ccApiOrder.fetchOrderHistory

Compatibility

This reference applies to:

Signature

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

Service Layer Classes

Logic Service Provider

ccrz.ccLogicOrderHistory

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 either of the following keys, but not both. If you don't include either key, the method returns a ccrz.ccApi.MissingInputException.

ccrz.ccApiOrder.PARAM_ORDER_ID_LIST

Set<String> of Salesforce IDs for the orders to query.

ccrz.ccService.SEARCHSTRING

String to use for searching order records.

For information about how this method evaluates these parameters, see the reference for the ccrz.ccLogicOrderHistory.fetchHistory logic service provider method.

Inputs (Optional)

The input map can also include the following keys:

ccrz.ccApi.API_SIZING

Map<String, Object> that specifies the scope of data that this method returns, including which fields the method returns for each record that matches the query.

ccrz.ccApiOrder.PARAM_ORDERLIMIT

Integer that specifies the maximum number of order records to query at one time.

ccrz.ccApiOrder.PARAM_ORDER_ITEM_LIMIT

Integer that specifies the maximum number of order item records to query at one time.

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

This method's output also includes the output of ccrz.ccApiOrder.search, ccrz.ccApiOrder.fetch, and ccrz.ccApiOrder.fetchOrderItems, if applicable.