Consumer Goods Cloud Developer Guide
jSummer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Get Started with Consumer Goods Cloud
Prerequisites
Triggering CSV Exports
Checking Job Status
Committing CSV Export
Retrieving CSV Exports
Derive and Copy Promotions with MetadataWizard and Business Object API
API End-of-Life Policy
REST API Endpoints
This section describes the different REST API endpoints.
| Available in: Lightning Experience in Enterprise and Unlimited Editions that have Consumer Goods Cloud Trade Promotion Management enabled. |
-
Abort Export Process
Uses the POST method to set the state of a CSV export process to Aborted. -
Get Measure Exports
Uses the GET method to retrieve the list of the exports scheduled for a particular period. -
Triggering CSV Exports
Use the Triggering CSV Exports API to trigger CSV exports simultaneously. The CSV exports are generated asynchronously. -
Checking Job Status
Use the CSV Export Job Status API to get the status of the scheduled export. The API uses the csvGuid of the scheduled export as an input parameter. -
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. -
Retrieving CSV Exports