Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Product catalog APIs

Updated on May 14, 2021
APIPurposeSample RequestComment
ProductOffersTo fetch the specific Product offer details { "ProductOffers": [{ "ID":"PO-4015", "Version":"", "DataToRetrieveList" : [{ "DataToRetrieve" : "Full" }]}]}
  1. if DataToRetrieve = Empty / Null then returns only the basic details. Basic details for each component are as follows:

    - Basic details of offer

    1. Simple offer: offer: Basic details like name, version, specification, catalog, configurations, contract terms etc.
    2. 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.

  2. if DataToRetrieve = All/Full then returns complete details of product offer.
  3. if DataToRetrieve = Pricing then returns complete details of pricing which include offer pricing ,pricing, specification pricing , pricing entity complete structure.
  4. if DataToRetrieve = Compatibility Rules then returns details of compatibility rules of offer.
  5. if DataToRetrieve = Configuration Rules then returns details of configuration rules of offer.
  6. if DataToRetrieve = Eligibility Rules then returns details of eligibility rules of offer.
  7. if DataToRetrieve = Extras then retruns entire structure of product offers associated as add-on or equipment.
  8. if DataToRetrieve = Specification detailsSpecification details + pricing + specification level configurations


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.
productoffersCustomTo fetch offers based on catalogid<ProductOffersRequest> <ID>PO-5779</ID> <Name></Name> <CatalogID></CatalogID> </ProductOffersRequest> Request in xml format
ProductVersionUpdatesTo update the versions of an exisitng offer{ "ProductOffers": [ { "ID":"PO-5779", "Version":"02" }, { "ID":"PO-5778", "Version":"01" } ]}
ProductoffersmultipleTo 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.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us