| API | Purpose | Sample Request | Comment |
| ProductOffers | To fetch the specific Product offer details | { "ProductOffers": [{ "ID":"PO-4015", "Version":"",
"DataToRetrieveList" : [{ "DataToRetrieve" : "Full" }]}]} | - if DataToRetrieve = Empty / Null then returns only the
basic details. Basic details for each component are as
follows:
- Basic details of offer - Simple offer: offer: Basic details like name, version,
specification, catalog, configurations, contract terms
etc.
- Bundle offer: offer: Entire structure of child
offers.
- Pricing: Pricing: Offer level pricing and pricing
entity structure. - Specification details: details:
ID, ID, name, version - Extras: Extras: Addons and -
Equipment: equipment: ID, name, version, optionality,
specification pricing. - if DataToRetrieve = All/Full then returns complete
details of product offer.
- if DataToRetrieve = Pricing then returns complete details
of pricing which include offer pricing ,pricing, specification
pricing , pricing entity complete structure.
- if DataToRetrieve = Compatibility Rules then returns
details of compatibility rules of offer.
- if DataToRetrieve = Configuration Rules then returns
details of configuration rules of offer.
- if DataToRetrieve = Eligibility Rules then returns
details of eligibility rules of offer.
- if DataToRetrieve = Extras then retruns entire structure
of product offers associated as add-on or equipment.
- if DataToRetrieve = Specification detailsSpecification
details + pricing + specification level
configurations
(characteristics).
|
| Pricingentities | To fetch complete details of a pricing entity id | [ { "EntityID":"PE-3027", "Version":"02" } ] | |
| Catalogs/{Id} | GET method to retrieve all catalogs (or) for given catalog
id. | | |
| productoffersCustom | To fetch offers based on catalogid | <ProductOffersRequest> <ID>PO-5779</ID> <Name></Name>
<CatalogID></CatalogID> </ProductOffersRequest> | Request in xml format |
| ProductVersionUpdates | To update the versions of an exisitng offer | { "ProductOffers": [ { "ID":"PO-5779", "Version":"02" }, {
"ID":"PO-5778", "Version":"01" } ]} | |
| Productoffersmultiple | To fetch multiple offers | { "ProductOffers": [ { "ID":"PO-5779", "Version":"02" }, {
"ID":"PO-5778", "Version":"01" } | |
Response for all the APIs
Use the request format in any third party tool / Pega REST connect wizard simulator to
get the response structure.
