This document focuses on the endpoints that needs to be called in the Pricing Service (PRS) to check for a promotions and discounts or enlist to one using a Promo Code.
All endpoints documented are subject to change.
Search for Promotions and Discounts
Get all Promotions and Discounts according to search criteria
This request is used to get all Promotions and Discounts according to search criteria, with paging and filtering.
The payload can be modified as required to make the search more stringent or leanient, omitting properties that is not required to filter on.
Note that enlistment will only happen on Promotions and Discounts that are in Active status.
{"items":[{"id":"49173726-6a04-4faf-8164-921078f992c7","collector_id":"271be0cd-09cf-4472-8fdc-7e7cc0baa8c3","promo_discount_type_id":1,"promo_category_id":16,"eligibility_filter_id":"c55189d2-6f8f-4338-ad6f-c081fa4d8938","name":"Deleted - Test Promo Complex Filter ","description":"This is Test Promo ","line_item_message":"Promotional Discount","promo_discount_status_id":4,"published_date":null,"auto_enlist":true,"promo_code":"478855DE - 5B24YM","gl_code":"74D78","goal_or_marketing_message":"Promotional Discount","start_date":"2025-01-17","end_date":"2025-01-30","service_usage_count":0,"price_type_id":2,"waive_activation_pro_rata":true,"adjustment_type_id":3,"adjustment_value":15,"period_length":6,"category_query_type_id":3,"collector_name":"HyperFiber Network","status":"Deleted","promo_discount_type_name":"Promotion","promo_category_name":"Promotion - Set no of Months","eligibility_filter_name":null,"price_type_name":"Monthly","adjustment_type_name":"Percentage","promo_status_class":null},{"id":"a030f438-3be6-4ac2-b8c4-03624e46479d","collector_id":"271be0cd-09cf-4472-8fdc-7e7cc0baa8c3","promo_discount_type_id":2,"promo_category_id":9,"eligibility_filter_id":"30c49d41-d344-45b2-8011-18db5cfa8fa4","name":"Test Discount with Date Range","description":"Negative date","line_item_message":"Historic Discount","promo_discount_status_id":1,"published_date":"2025-01-27","auto_enlist":true,"promo_code":"","gl_code":"","goal_or_marketing_message":"Historic Discount","start_date":"2024-10-31","end_date":"2024-11-30","service_usage_count":0,"price_type_id":2,"waive_activation_pro_rata":false,"adjustment_type_id":3,"adjustment_value":10,"period_length":0,"category_query_type_id":1,"collector_name":"HyperFiber Network","status":"Active","promo_discount_type_name":"Discount","promo_category_name":"Historic Discount","eligibility_filter_name":null,"price_type_name":"Monthly","adjustment_type_name":"Percentage","promo_status_class":null}],"page":1,"count":2,"total":2}
Important information and definitions regarding search criteria
Promotion/Discount start and end dates define the period when enlistment can happen, even if the promotion or discount will be applied to a future purchase.
Promotion/Discount publish date refers to when the Promotion/Discount was made active.
To filter on the Promotion/Discount status, use the following values:
Active = 1,
PublishedFutureDated = 2,
Draft = 3,
Deleted = 4,
Expired = 5
PageNumber and PageSize are used for paging, with PageSize being the number of items to return per page.
Enlist in a Promotion or Discount
When a service is eligible to takepart in a Promotion or Discount, it must enlist to it before its benefit will be applied to its pricing.
Enlistment will happen in two ways, dependent on how the Promotion or Discount is setup:
1. Auto Enlistment: The Promotion or Discount is setup to automatically enlist all services that are eligible.
2. Enlistment by PromoCode: The Promotion or Discount is setup to require a Promo Code to be entered before the service can enlist.
This endpoint will enlist the service to the Promotion or Discount by providing the ServiceId and PromoCode.
Response will contain the Service object and the Promo Discount object.
Get all Promotions and Discounts associated with a Service
This endpoint will retrieve all the Promotions and Discounts that the service enlisted to by providing the ServiceId.
Response will contain a colletion of Promotions and Discounts.