This document focuses on the endpoints that needs to be called in the Pricing Service (PRS) to check for a Bolt On or enlist to one using a Bolt On Code.
All endpoints documented are subject to change.
Note that bolt-on payloads reference "promo" fields. This is by design.
Search for Bolt Ons
Get all Bolt Ons according to search criteria
This request is used to get all Bolt Ons according to search criteria, with paging and filtering.
The payload can be modified as required to make the search more stringent or lenient, omitting properties that is not required to filter on.
Note that enlistment will only happen on Bolt Ons that are in Active status.
{"items":[{"id":"49173726-6a04-4faf-8164-921078f992c7","collector_id":"271be0cd-09cf-4472-8fdc-7e7cc0baa8c3","promo_discount_type_id":3,"promo_category_id":16,"eligibility_filter_id":"c55189d2-6f8f-4338-ad6f-c081fa4d8938","name":"Test Bolt On ","description":"This is a Test Bolt On ","line_item_message":"Test Bolt On","promo_discount_status_id":4,"published_date":null,"auto_enlist":true,"promo_code":"478855DE - 5B24YM","gl_code":"74D78","goal_or_marketing_message":"Promotional Bolt On","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":"Bolt On","promo_category_name":"Bolt On - 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":3,"promo_category_id":9,"eligibility_filter_id":"30c49d41-d344-45b2-8011-18db5cfa8fa4","name":"Test Bolt On with Date Range","description":"Bolt On Test Date","line_item_message":"Bolt On Test","promo_discount_status_id":1,"published_date":"2025-01-27","auto_enlist":true,"promo_code":"","gl_code":"","goal_or_marketing_message":"Bolt On Test","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":"Bolt On","promo_category_name":"Bolt On Test","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
Bolt On start and end dates define the period when enlistment can happen, even if the bolt-on will be applied to a future purchase.
Bolt On publish date refers to when the Bolt On was made active.
To filter on the Bolt On 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 Bolt On
When a service is eligible to takepart in a Bolt On, it must enlist to it before its benefit will be applied to its pricing.
Enlistment will happen via PromoCode only: The Bolt On is setup to require a Bolt On (Promo) Code to be entered before the service can enlist.
This endpoint will enlist the service to the Bolt On by providing the ServiceId and PromoCode.
Response will contain the Service object and the Promo Discount object.
Get all Bolt Ons available for enlistment with a Service
This endpoint will retrieve all the Bolt Ons that are available for enlistment for a particular service.
Response will contain a collection of Bolt Ons.