Consumer Goods Cloud Developer Guide

Get Started with Consumer Goods Cloud
Retail Execution
Trade Promotion Management
Custom Objects for Trade Promotion Management
Exporting the KPIs from Hyperforce
Prerequisites
Configuring Integration Dimension Meta
Triggering the CSV Export Process
REST API Endpoints
Abort Export Process
Get Measure Exports
Triggering CSV Exports
Checking Job Status
Committing CSV Export
Retrieving CSV Exports
Examples
CGCloud Namespace
Trade Promotion Management Business APIs
Apex Classes for Trade Promotion Management
Derive and Copy Promotions with MetadataWizard and Business Object API
Promotion Wizards & Customization
Metadata Wizard
Business Objects API
Custom Objects for Retail Execution and Trade Promotion Management
Standard and Custom Objects for Future Use
API End-of-Life Policy
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Committing CSV Export

Use the Commit CSV Export API to commit a specific csvGuid and take the related CSV as a new baseline for future delta exports. This means after this commit, the next delta export contains only those records in the KPIs that have been either added, changed, or deleted from the previous committed state.

The current version of a metadata configuration is available in the response of Checking Job Status. For example: "metaVersion": 8. If the underlying RTR Report Configuration record in a Salesforce org changes, then the previous commit is no longer valid for a delta export. A full export is scheduled next time.

Resource
/services/apexrest/cgcloud/measures/export/{{csvguid}}/commit
Method
POST

Path Parameters

URL Parameter Sample Value Description
csvGuid 3b549543-d420-401a-b424-29c7f3c75713 Enter the csvGuid value of the scheduled CSV export. This value is received as a response to the API request sent to Triggering CSV Exports API.

Request Parameters

Parameter Mandatory Type Description
businessyear Yes Integer Enter the business year for which the CSV export must be triggered.
metaname Yes String Enter the Internal Name of the RTR Report Configuration.
salesorg Yes String Enter the Salesorg ID.

Sample Request Body

1{
2    "salesorg": "0001",
3    "metaname": "IntegrationExportPromotion",
4    "businessyear": 2024
5}

Sample Response Body

1{"csvGuid":"5a2cb107-bc1f-4995-a782-291ec3d62d55","commitdate":"Fri, 01 Aug 2025 13:02:28 GMT"}