Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Club Member Enrollment
Club Member Profile
Club Membership Renewal
Corporate Member Enrollments
Individual Member Enrollments
Member Benefits
Member Profile
Member Engagement Trail
Member Vouchers
Redeem Voucher
Transaction History
Transaction Ledger Summary
Transaction Journals Execution
Transaction Journals Simulation
Loyalty Program Process
Gamification
Promotion
Eligible Promotions List (POST)
Promotion Configuration (GET)
Clone Promotion (POST)
Coupon Usage Increase
Coupon Usage Decrease
Promotions Creation (POST, PUT)
Promotion Details (GET, PUT)
Promotion Execution (POST)
Promotion Recommendations (POST)
Promotion Reward Application (POST)
Request Bodies
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Promotion Configuration (GET)

View configuration of a promotion, including its definition, eligibility criteria, rules, limits, and related rule library version. The Promotion Configuration API enables developers and system integrators in your company to view the configuration of active promotions in your Salesforce org and export the configuration to external systems such as offline point-of-sale (POS) systems.

Special Access Rules

The Promotion Configuration API is only available in orgs where Global Promotions Management is available.

Resource
1/global-promotions-management/promotions/promotionId/configuration
Resource example
1https://yourInstance.salesforce.com/services/data/v65.0/global-promotions-management/promotions/promotionId/configuration
Available version
61.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
promotionId String ID of the active promotion you want to view.The ID must belong to a promotion whose rules are configured using a non-Loyalty promotion template. Required 61.0
relatedObjectAndFieldApiNames String[] The list of related object fields whose details you want to view for the promotion. To view the details of a field, specify the API name of the object that the field belongs to and the API name of the field, separated by a period. relatedObjectAndFieldApiNames can pass only one field per object. Optional 61.0
Response body for GET
Promotion Configuration