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.

Retrieving CSV Exports

The response body is a binary file and can be saved locally. This file with the ending csv.gz is a zipped CSV file, so it must be extracted first.

Endpoint

<CGCloud Processing Services Integration>/api/v1/files/getcsv/{{csvGuid}}?path={{full or delta}}

You can get the CGCloud Processing Services Integration value from the Processing Services Pairing App page in your Salesforce org.

Note

HTTP Method

GET

URL Parameter Mandatory Sample Values
csvGuid Yes 3b549543-d420-401a-b424-29c7f3c75713
path Yes Must be either:
  • tpm/long/export/full (to retrieve a full export)
  • tpm/long/export/delta (to retrieve a delta export)