Additional APIs
- ProductOffers:Request:
{
"ProductOffers":
[{
"ID":"PO-4015",
"Version":"", "DataToRetrieveList" :
[{
"DataToRetrieve" : "Full"
}]}]}
DataToRetrieve parameter
Parameter: Empty/Null
Returns only the basic details. Basic details for each component are as follows:
- Basic details ofoffer
- Simpleoffer: Basic details like name, version, specification, catalog, configurations, and contract terms etc.
- Bundle offer: Entire structure of childoffers.
- Pricing: Offer level pricing and pricing entitystructure.
- Specification details: ID, name, and version
- Extras: Addons and equipment: ID, name, version, optionality, and specification pricing.
Parameter: All/Full
Complete details of product offer.
Parameter: Pricing
Complete details of pricing which include offer pricing, specification pricing , pricing entity complete structure.
Parameter: Compatibility Rules
Details of compatibility rules of offer.
Parameter: Configuration Rules
Details of configuration rules of offer.
Parameter: Eligibility Rules
Details of eligibility rules of offer.
Parameter: Extras
Entire structure of product offers associated as add-on or equipment.
Parameter: Specification details
Specification details + pricing + specification level configurations(characteristics).
Response
Use the request format in any third-party tool / Pega REST connect wizard simulator to get the response.
- Basic details ofoffer
- Pricingentities:
[
{
"EntityID":"PE-3027",
"Version":"02"
}
]
- Catalogs/{Id} – GET method to retrieve all catalogs (or) for given catalogid.
- productoffersCustom:
request: XMLformat
<ProductOffersRequest>
<ID>PO-5779</ID>
<Name></Name>
<CatalogID></CatalogID>
</ProductOffersRequest>
- ProductVersionUpdates:
Request:
{
"ProductOffers":
[
{
"ID":"PO-5779",
"Version":"02"
},
{
"ID":"PO-5778",
"Version":"01"
}
]}
- Productoffersmultiple:
Request:
{
"ProductOffers":
[
{
"ID":"PO-5779",
"Version":"02"
},
{
"ID":"PO-5778",
"Version":"01"
}
]}
| API | Purpose | Sample Request | Comment |
| ProductOffers | To fetch the specific Product offer details | { "ProductOffers": [{ "ID":"PO-4015", "Version":"", "DataToRetrieveList" : [{ "DataToRetrieve" : "Full" }]}]} |
|
| 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.
Previous topic TMForumAPI Next topic Bulk upload