Get Started with Integration Service API
Explore API endpoints to access Consumer Goods Cloud Trade Promotion Management (TPM) features and run it as a transactional system.
Health Check
Check the API version of Consumer Goods Cloud Trade Promotion Management (TPM).
Manage Explicit Transactions
Manage explicit transactions for multi-message operations.
- Register a transaction ID
- Get a List of Transactions for a Time Period
- Delete a transaction including messages
Manage Templates for Measures
Manage templates for measures including volumes, actuals, prices, or discounts.
- Configure condition measures
- Get a list of configured measure templates
- Get a list of configured volume measure templates
- Configure volume measures (Weekly or Daily)
Send, Retrieve, or Delete Volumes or Baselines
Manage volumes and promotion or tactic data.
- Send volumes of type integer by date on weekly basis
- Send volumes of type integer by date on daily basis
- Send volumes of type integer by week on a weekly basis
- Send volumes of type decimal on a weekly basis
- Send volumes of type decimal on a weekly basis with start date
- Send volumes of type decimal on a weekly basis with year and week
- Get volumes on weekly basis for a specified date
- Get volumes for a specified Date
- Get volumes for a week of the year
- Delete volumes of type integer for a year ending before the specified date
- Delete volumes of type decimal for a year ending before the specified date
- Delete volumes of type decimal on weekly basis that span the given time range
- Delete volumes of type integer on weekly basis
- Delete volume information before one month of the specified date
- Delete volumes of type decimal older than the specified date
- Delete volumes of type decimal on daily basis that span the given time range
- Delete volumes of type integer on daily basis
- Send Promotion or Tactic Specific Actuals (volumes) on weekly level with type decimal values for a registered transaction
- Get Promotion or Tactic Specific Actuals (volumes) on a weekly basis for a specified date
- Get Promotion or Tactic Specific Actuals (volumes) for a specified date
- Get Promotion Actuals on a Weekly Basis
- Get Promotion Actuals on a Daily Basis
- Delete Promotion or Tactic Actual Data on a Daily Basis
- Get Promotion or Tactic Specific Actuals (volumes) for a week of the year
- Delete Promotion or Tactic Specific Actuals (volumes) on daily basis older than the specified date
- Delete Promotion or Tactic Actual Data in Bulk on a Daily Basis
- Delete Promotion or Tactic Specific Actuals (volumes) on a weekly basis for a year ending before the given date
- Delete Promotion or Tactic Actual Data on a Weekly Basis
- Delete Promotion or Tactic Actual Data in Bulk on a Weekly Basis
- Send Promotion or Tactic Specific Actuals (volumes) of type decimal on a weekly basis for a registered transaction
- Send Promotion or Tactic Specific Actuals (volumes) of type decimal on a daily basis for a registered transaction
Manages Measures
Manage measures for conditions like prices, discounts, and costs.
- Send product prices for a registered transaction
- Send product discounts for a registered transaction
- Send account discounts for a registered transaction
- Send account costs for a registered transaction
- Send account or products prices for a registered transaction
- Send account or products costs for a registered transaction
- Get accounts product measures for a measure type
- Delete measures for products per accounts based on measure type
- Delete conditions in bulk mode for accounts products
- Delete conditions in bulk mode for account measures
- Delete conditions in bulk mode for product measures
- Request account measures for a measure
- Delete measures for accounts based on measure type
- Request product measures for a measure type
- Delete measures for products based on measure type
- Request data for a selected account and year
- Request data for a selected account and year
Retrieve Account Plans That Have Changed
Retrieve the list of changed account plans based on date and time
- Get the account plans that have changed since the specified date and time
- Get the account plans that have changed since compared with the send list of account plans, year, and ETAGs
Retrieve or Compare Manual Inputs for an Account Plan
Retrieve the manual inputs recorded in a session for an account plan or its comparison between two sessions.
Retrieve Available Promotions
Retrieve available promotions that are processed within Consumer Goods Cloud Processing Engine.
- Get available promotions within a sales org
- Get promotions that have changed since the specified date and time
- Get promotions that have changed since compared with the send list of promotions and ETAGs
- Get data for a single promotion and promotion level KPIs using pagination
- Get data for a single promotion
- Get the total values for KPIs over all products for all periods spanning the promotion runtime
- Get available tactics for a specified promotion
- Get data for a specified promotion tactic
- Get aggregated data for a specified promotion tactic
- Get a list of products that created at least one writeback
Retrieve Available Accounts
Retrieve available accounts and transfer them into the internal structures of the Consumer Goods Cloud Processing services.
- Get accounts available and successfully transferred into Consumer Goods Cloud Processing services internal structures
- Get products available and successfully transferred into Consumer Goods Cloud Processing services internal structures
- Analyze internal data structures for integer values on weekly basis
- Analyze internal data structures for decimal values on weekly basis
- Analyze internal data structures for integer values on daily basis
- Analyze internal data structures for decimal values on daily basis
- Analyze internal data structures of type decimal on weekly basis
- Analyze internal data structures of type decimal on daily basis
- Get a list of all dependencies for a specified account
Manage Users and Privileges
Manage users and privileges including audit logging.
- Get all registered users
- Add a user
- Update an existing user
- Delete a specified user
- Get user history
Manage File Requests
Retrieve Payments
Get payment details within Consumer Goods Cloud Processing Engine.
Related Documentation
- TPM Service APIs
- TPM Engine Workflows
- TPM Promotion Creation Workflow
- TPM User Interface Customization
j