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.

Triggering CSV Exports

Use the Triggering CSV Exports API to trigger CSV exports simultaneously. The CSV exports are generated asynchronously.

Account Plan measure exports include data from weekly account and promotion writebacks. For promotion writebacks, if a product moves to a new category and promotions reference both the old and new categories, the export shows separate rows for each category for the same product and measure code.

Note

Resource
/services/apexrest/cgcloud/measures/export/schedule
Method
POST

Request Parameters

Parameter Mandatory Type Description
businessyear Yes only if calendaryear is not provided as an input. Integer Enter the business year for which the CSV export must be triggered. It is used when the write-back datasource is exported.
calendaryear Yes only if businessyear is not provided as an input. Integer Enter the calendar year for which the CSV export must be triggered. It is used for inbound integration data sources.
metaname Yes String Enter the Internal Name of the RTR Report Configuration.
salesorg Yes String Enter the Salesorg name.

Sample Request Body

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

Sample Response Body

1{
2  "csvGuid": "94f49a3f-37bc-4794-8051-123456789"
3}