Returning a Promotion Definition

When you use the Siebel REST API to return the entire structure of a specific promotion, the Siebel application returns the entire promotion definition or structure, including relationship and component hierarchy details, the pricing for components and aggregate, and the promotion commitment terms for the given promotion. This REST API returns the promotion definition defined using promotion designer in the Product Promotions view in Administration - Product.

The following request returns the entire structure of a specific promotion:

URI: http://ServerName:port/siebel/v1.0/service/Workflow Process Manager/RunProcess
HTTP Method: POST
Content-Type: application/json
Authorization: Basic

Request body:

 	{
	"body": {
		"ProcessName": "ISS Promotion WS - GetProductPromotionDetails",
		"ProdPromId": "88-3N1ZN",
		"LoadPromDefFlag": "Y",
		"LoadStructFlag": "Full",
		"LoadAllDomainFlag": "Y",
		"LoadDefaultDomainFlag": "N",
		"ProdPromRuleType": "Product"
	"Context": {
 "IntObjectFormat": "Siebel Hierarchical",
 "MessageId": "",  
 "IntObjectName": "PDS Catalog Context",
 "MessageType": "Integration Object",
 "ListOfPDS Catalog Context": {
 "Context": {} 
 }
 }
 } 
 }

For a description of the request message associated with this API, see the following table.

Name	Description
Process Name	The following process is required: ISS Promotion WS - GetProductPromotionDetails
ProdPromId	Required. Row ID of the promotion.
LoadPromDefFlag	Optional. The default value is Y. Returns the promotion definition structure.
LoadStructFlag	Optional. There is no default value. Valid values are Full, Modified or no value. If set to Full, then it returns all the promotion rules. If set to Modified, then it returns all the promotion rules that are different from the product definition. When no value is specified and is empty, and ProdPromRuleId is passed, then it only returns the rule with the ID that is passed.
LoadAllDomainFlag	Optional. The default value is N. If the value is Y, then it returns the structure of the underlying product.
LoadDefaultDomainFlag	Optional. The default value is Y. Returns the default product under the promotion aggregate relationship.
ProdPromRuleType	Optional. The default value is Product. Valid values are Product and Pricing.
ProdPromRuleId	Required when no value is set for LoadStructFlag field, or when the LoadDefaultDomainFlag value is Y.
Context	Optional. However required if LoadDefaultDomainFlag is Y. Filters the promotion aggregate relationship based on the ProdPromRuleId and the ProductSearchSpec in the context.

Here are the response details for a successful request:

HTTP Code: 200
Content-Type: application/json

Response body:

    	            {
	"Error Code": "",
	"Error Message": "",
	"DomainProductDetail": {
		"IntObjectFormat": "Siebel Hierarchical",
		"MessageId": "88-23C8R",
		"IntObjectName": "SWI Admin ISS Product Definition",
		"MessageType": "Integration Object",
		"SWI Internal Product VOD": [
			{
				"Product Type Code": "Product",
				"Product Def Type Code": "Customizable",
				"Name": "ACR722GetPromoWS_CP1",
				"Price Type": "One-Time",
				"Integration Id": "88-3MERG",
				"Id": "88-3MERG",
				"SWI ISS Product VOD BusComp": {
					"VOD Id": "88-3MERG",
					"VOD Name": "ACR722GetPromoWS_CP1",
					"VOD Type": "ISS_PROD_DEF",
					"SWI ISS Product Details BusComp": {
						"Orig Id": "88-3MERO",
						"Object Id": "88-3MERM",
						"Pre Pick CD": "",
						"Parametric Search Flg": "",
						"Last Version": "0"
					},
					"SWI ISS Product Structure Admin BusComp": {
						"Prod Id": "88-3MEQB",
						"Object Id": "88-3MERM",
						"Item Name": "SP1",
						"Type": "Product",
						"Class Name": "",
						"Orig Id": "88-3MERQ",
						"Product Name": "ACR722GetPromoWS_SP1",
						"Sequence Num": ""
					},
					"SWI ISS Product Versions BusComp": {
						"Version": "2",
						"VOD Id": "88-3MERM",
						"Version Id": "88-3MERN"
					}
				},
				"SWI Internal Product Organization": {
					"Product Id": "88-3MERG",
					"Organization Id": "0-R9NH"
				}
			},
			{
				"Parent Internal Product Name": "",
				"Image Primary Organization Name": "",
				"Product Type Code": "Product",
				"Product Def Type Code": "Customizable",
				"VOD Id": "88-3MESC",
				"Special Rating Max Items": "",
				"Sequence Number": "",
				"Part #": "",
				"Fulfillment Criteria Code": "Default",
				"Auto Allocate Flag": "Y",
				"Name": "ACR722GetPromoWS_CP2",
				"SWI ISS Product VOD BusComp": {
					"VOD Id": "88-3MES6",
					"VOD Name": "ACR722GetPromoWS_CP2",
					"VOD Type": "ISS_PROD_DEF",
					"SWI ISS Product Details BusComp": {
						"Parent VOD Id": "",
						"Orig Id": "88-3MESE",
						"SPN Definition Id": "",
						"Object Id": "88-3MESC"
					},
					"SWI ISS Product Structure Admin BusComp": [
						{
							"Prod Id": "88-3MEQW",
							"Object Id": "88-3MESC",
							"Item Name": "SP2",
							"Min Cardinality": "1",
							"Type": "Product",
							"Object Number": "88-3MEQW",
							"Orig Id": "88-3MESI",
							"Product Name": "ACR722GetPromoWS_SP2"
						},
						{
							"Prod Id": "88-3MEQB",
							"Max Cardinality": "1",
							"Object Id": "88-3MESC",
							"Item Name": "SP1",
							"Type": "Product",
							"Forcastable Flag": "Y",
							"Orig Id": "88-3MESG",
							"Product Name": "ACR722GetPromoWS_SP1"
						}
					],
					"SWI ISS Product Versions BusComp": {
						"VOD Id": "88-3MESC",
						"Latest Released Flag": "N"
					}
				},
				"SWI Internal Product Organization": {
					"Product Id": "88-3MES6",
					"Organization Id": "0-R9NH"
				}
			},
			{
				"Product Type Code": "Product",
				"Product Def Type Code": "Simple",
				"VOD Id": "88-3MER2",
				"Name": "ACR722GetPromoWS_SP2",
				"Primary Organization Id": "0-R9NH",
				"Integration Id": "88-3MEQW",
				"Id": "88-3MEQW",
				"Dynamic Discount Method": "Amount",
				"SWI ISS Product VOD BusComp": {
					"VOD Id": "88-3MEQW",
					"VOD Name": "ACR722GetPromoWS_SP2",
					"SWI ISS Product Details BusComp": {
						"Orig Id": "88-3MER4",
						"Object Name": "0",
						"Object Id": "88-3MER2"
					},
					"SWI ISS Product Versions BusComp": {
						"Version": "2",
						"VOD Id": "88-3MER2",
						"Version Id": "88-3MER3"
					}
				},
				"SWI Internal Product Organization": {
					"Product Id": "88-3MEQW",
					"Organization Id": "0-R9NH"
				}
			}
		]
	},
	"ProdPromDefinition": {
		"IntObjectFormat": "Siebel Hierarchical",
		"MessageId": "88-23C8Q",
		"IntObjectName": "ISS Promotion",
		"MessageType": "Integration Object",
		"ISS Promotion": {
			"Configuration Model Id": "88-3N1ZN",
			"Name": "ACR722GetProm3",
			"Promotion Type": "Bundled Promotions",
			"Promotion Id": "88-3N1ZN",
			"ISS Promotion Items for Import": [
				{
					"XA Modified Flag": "N",
					"Prod Id": "88-3MES6",
					"Prod Cfg Model Id": "88-3MES6",
					"Integration Id": "88-3N1ZW",
					"Promotion Id": "88-3N1ZN",
					"Maximum Quantity": "1",
					"Default Quantity": "1",
					"Product Name": "ACR722GetPromoWS_CP2"
				},
				{
					"Prod Id": "88-3MEQW",
					"Prod Cfg Model Id": "88-3MEQW",
					"Integration Id": "88-3N200",
					"Promotion Id": "88-3N1ZN",
					"Disconnect Action": "Modify",
					"Grace Period UOM": "Days",
					"Product Name": "ACR722GetPromoWS_SP2"
				},
				{
					"Prod Id": "88-3MERG",
					"Integration Id": "88-3N202",
					"Maximum Quantity": "1",
					"Default Quantity": "1",
					"Product Name": "ACR722GetPromoWS_CP1"
				}
			],
			"ISS Promotion Pricing Rules Summary": [
				{
					"Adjustment Type": "% Discount",
					"Prod Cfg Model Id": "88-3MES6",
					"Matrix Rule Num": "296-6114527",
					"Promotion Id": "88-3N1ZN",
					"Product Id": "88-3MES6",
					"Product Name": "ACR722GetPromoWS_CP2"
				}
			],
			"ISS Promotion Pricing Components": [
				{
					"Matrix Rule Num": "296-6114527",
					"Product Id": "88-3MES6",
					"Product Name": "ACR722GetPromoWS_CP2",
					"Product Promotions Relationship VBC": [
						{
							"Class Name": "",
							"Min Cardinality": "",
							"Parent Product Name": "ACR722GetPromoWS_CP2",
							"Promotion Id": "88-3N1ZN",
							"Product Name": "ACR722GetPromoWS_SP1",
							"Prod Id": "88-3MEQB"
						}
					]
				},
				{
					"Promotion Id": "88-3N1ZN",
					"Product Id": "88-3MEQW",
					"Product Name": "ACR722GetPromoWS_SP2"
				},
				{
					"Promotion Id": "88-3N1ZN",
					"Product Id": "88-3MERG",
					"Product Name": "ACR722GetPromoWS_CP1",
					"Product Promotions Relationship VBC": {
						"Parent Product Name": "ACR722GetPromoWS_CP1",
						"Parent Product Id": "88-3MERG",
						"Promotion Id": "88-3N1ZN",
						"Relationship Name": "SP1",
						"Product Name": "ACR722GetPromoWS_SP1",
						"Prod Id": "88-3MEQB"
					}
				}
			]
		}
	},
	"PromDomainProduct": {
		"IntObjectFormat": "Siebel Hierarchical",
		"MessageId": "",
		"IntObjectName": "PDS Product Interface",
		"MessageType": "Integration Object",
		"Product": {}
	}
}