Overview
- The TMF671 API offers a standardized way for service providers to configure and manage promotions. Using the TMF671 API, service providers can determine, based on predefined criteria, whether promotions such as additional discounts, vouchers, bonuses, or gifts can be applied.
- The execution of promotions is the responsibility of the enterprise platform that applies the discounts, vouchers, bonuses, or gifts, based on the information retrieved from the TMF671 API.
- Following block diagram provides a high-level overview of how the various components are involved in handling TMF671 API operations (GET, POST).
- Using TMF671 API you can perform these operations on customer account.
- Retrieve the list of promotions from the system
- Get the promotion details
- Create a promotion
It is assumed that you have completed the these.
- Enabling Access to Industry APIs
- Ensuring that the required licenses and data packs are installed. For more information.
Following block diagram provides a sequence of operations involved.
NOTE:
- For mandatory fields and resource mappings, refer TMF671 v4 Resource Mappings.
| I want to | Request Type | Example URL |
|---|---|---|
| Retrieve and display details of a particular promotion. | GET by ID | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion/{promotionCode} NOTE: For invalid customer ID, you receive HTTP 404 error. |
| Based on the provided field values, retrieve and display details of promotion. | GET with Fields | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion?fields=name NOTE: The requested fields are part of output, if they have value. |
| List all the promotions present in the system. | GET List | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion |
| List promotion details present in the system based on the filter applied. | GET List with Filtering | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion?name={name} NOTE: The requested fields are part of output, if they have value. |
| List promotions, limit the number of promotions to a maximum of specified limit, and starts the results display from page specified by offset. | GET List by limit and offset | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion?offset=2&pageLimit=2&pageinfo=true |
| Create a new promotion by providing the required details. | POST | {{orgendpoint}}/services/data/{{version}}/connect/comms/promotionManagement/v4/promotion NOTE: A new customer account gets created based on the values mentioned for the mandatory fields. |
Consider you want to retrieve details of a particular promotion.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion/TMF671PostRequest10
Consider you want to retrieve details of the promotion and get these details in the output.
- name
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion?fields=name
Consider there are multiple promotions in the system and you want to list all of them.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion
Consider you want to retrieve all the promotions present in the system with applied filter values.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion?name=CustomButtonsStep
Consider you want to
- Retrieve a list of promotions
- Limit the number of promotions to a maximum of specified limit
- Start the results display from page specified by offset
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion?offset=2&pageLimit=2&pageinfo=true
NOTE: If there are multiple quotes, the above pagination query - limit=2&offset=70 will start display from page 70 and will have 2 records.
Consider you want to create a new promotion with full payload.
https://vlocity-1f5-dev-ed.develop.my.salesforce.com/services/data/v63.0/connect/comms/promotionManagement/v4/promotion