Schedule Global Account Product List

Schedules a job to update the global account product list.
Soft limits:
  • Maximum number of accounts based on AccountLoaderMaxNumberOfAccounts. Default value is 1000.
Note

Note

The jobthreads value of 1 is intentional for this endpoint and should remain unchanged.

Resource

SCHEDULE_GLOBAL_ACCOUNT_PRODUCT_LIST

Available version

55.0

Apex Request Example

// Logical endpoint name
String endpointName = 'SCHEDULE_GLOBAL_ACCOUNT_PRODUCT_LIST';
// name of the salesorg for which the API must be scheduled
String salesOrg = '0001';
<namespace>.OffplatformCallout callout = new <namespace>.OffplatformCallout(endpointName, salesOrg);
// Log Transaction Id
String txId = <namespace>.TransactionHandler.getTransactionIdentifier();
// Account Id for which the products in the global apl should be retrieved
Id accountId = '001B000001Q48yMIAR'; // Kroger Atlanta
Map<String, String> urlParameters = new Map<String,String>();
Map<String, Object> payloadParams = new Map<String, Object>();
payloadParams.put('jobname', 'GlobalAPLUpdate');
payloadParams.put('salesorg', salesOrg);
payloadParams.put('accountids', new List<Id>{accountId}); // up to 1000 accounts
payloadParams.put('refreshaccountproductlist', false); // add only new products or recalculate completely
payloadParams.put('batchchain', 'TPM_Calculation_Chain_<timestamp>');
payloadParams.put('jobthreads',  1);
String payload = JSON.serialize(payloadParams);
<namespace>.OffplatformCalloutResponse response = callout.execute(txId, urlParameters, payload);
if (response.status != 200) {
   // Handle error and return error info to caller
}