Returning a Promotion Definition by Name
When you use the Siebel REST API to return the entire structure of a specific promotion by querying by name, 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:
{ "ProcessName": "ISS Promotion WS - GetProductPromotionDetails QBE", "LoadPromDefFlag": "Y", "LoadStructFlag": "Full", "LoadAllDomainFlag": "Y", "LoadDefaultDomainFlag": "N", "ProdPromRuleType": "Product", "SiebelMessage": { "IntObjectFormat": "Siebel Hierarchical", "MessageId": "", "IntObjectName": "ISS Promotion WS", "MessageType": "Integration Object", "ListOfISS Promotion WS": { "ISS Promotion": { "Name": "SDX Basic" } } }
For a description of the request message associated with this API, see the following table.
| Name | Description |
|---|---|
|
Process Name |
The following process is required:
|
|
LoadPromDefFlag |
Optional. The default value is Y. |
|
LoadStructFlag |
Optional. There is no default value. Valid values are Full, Modified or no value.
|
|
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. |
|
SiebelMessage |
Required. A Siebel Message is a message containing the data of individual integration object instances. An Instance of “ISS Promotion WS” Integration Object is passed to query the promotion by name. |
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-2ABAH", "IntObjectName": "SWI Admin ISS Product Definition", "MessageType": "Integration Object", "ListOfSWI Admin ISS Product Definition": { "SWI Internal Product VOD": [ { "Parent Internal Product Name": "", "Image Primary Organization Name": "", "Product Type Code": "Product", "Territory Item Type": "", "Price Book Currency Code": "", "Sales Product Flag": "Y", "Configuration Model": "", "ImageFileSDX BasickReqFlg": "", "Image Name": "", "Configuration": "N", "Terms": "", "Standard Cost": "", "Case Pack": "", "Carrier": "", "Unit of Measure": "", "ThumbnImageFileSrcType": "", "Configuration File": "", "List Price Type Code": "", "Thumbnail Image Description": "", "Inclusive Eligibility Flag": "N", "ThumbnImageFileSrcPath": "", "Price List Item Id": "", "Billing Type": "", "Prod Eff Start Date": "", "Tax Subcomponent Flag": "N", "Service Type": "", "Global Product Identifier": "", "Product Def Type Code": "Customizable", "VOD Id": "88-1X5VSA", "Product Id": "", "Tool Flag": "", "Promotional Price": "", "Override Rollup Flag": "", "ThumbnImageFileSDX BasickReqFlg": "", "Vendor Primary Organization Id": "", "Volume Discount Method": "", "Target Version Flag": "N", "Parent Internal Product Part #": "", "Version": "", "Parent Internal Product Vendor": "", "Start Date": "", "Special Rating Max Items": "", "Sequence Number": "", "Part #": "", "Fulfillment Criteria Code": "Default", "Ext OT Pct Increase": "", "Cost List Item Currency Code": "", "Product Image Integration Id": "", "CDA Project": "", "ThumbnImageFileSize": "", "Unit Conversion Factor": "", "International Build": "", "Units In Inventory": "", "Inventory Flag": "", "ImageFileSrcType": "", "Type": "", "Product Type": "", "Vendor Part Number": "", "Build": "", "Defective Product State": "", "Pricing Method": "", "ImageFileSrcPath": "", "ThumbnImageFileName": "", "Vendor": "", "Phone Number Flag": "N", "Fulfillment Item Code": "", "Parent Internal Product Id (Joined)": "", "Next Cost": "", "Average Cost": "", "Lead Time": "", "Maximum Quantity": "", "Service Instance": "N", "Parent Internal Product Primary Organization Id": "", "Parent Internal Product Vendor Organization Id": "", "Auto Allocate Flag": "Y", "Global Product Classification Code": "", "Cost": "", "Product Cost": "", "MTBF": "", "Pricing Commit Type": "Dynamic", "Allocate Below Safety Flag": "Y", "List Price": "", "Primary Product Line Id": "No Match Row Id", "Name": "SDX Data Service", "ThumbnImageFileRev": "", "XA Class Id": "", "External Inventory System Ref": "", "Product Thumbnail Image Id": "", "ThumbnImageFileDeferFlg": "", "Vendor Primary Organization": "", "Max Sale Price": "", "Taxable Flag": "N", "Image Primary Organization Id": "", "Display Component Price": "", "Targeted Country": "", "Bill on First Service": "Y", "Shipping Method": "", "Targeted Postal Code": "", "Price Book Name": "", "ThumbnImageFileExt": "", "ImageFileAutoUpdFlg": "", "XA Class Name": "", "ImageFileSize": "", "Product Level": "", "ThumbnImageFileDate": "", "Primary Equivalent Product Id": "No Match Row Id", "ThumbnImageFileSDX BasickStatFlg": "", "Global Supply Chain Code": "", "Std OT Pct Increase": "", "Price List Item Start Date": "", "Billable Flag": "Y", "Parent Internal Product Primary Organization": "", "MSRP": "", "ImageFileName": "", "Field Replacable Unit": "", "CDA Project Id": "", "Active Flag": "Y", "Targeted Industry": "", "Price Book Id": "", "Auto Substitute Flag": "Y", "Vendor Id": "", "Pre Pick CD": "N", "Last Cost": "", "Billing Service Type": "", "Parent Internal Product Vendor Organization": "", "Volume Discount Id": "", "Cfg Version": "2", "Product Image Id": "", "SAP Division Code": "", "Compound Flag": "N", "Version Status": "", "SPN Definition Type": "", "Vendor Integration Id": "", "Parent Internal Product Integration Id": "", "Unit Size": "", "Price Type": "One-Time", "ImageFileRev": "", "Class Product Code": "Product", "ImageFileSDX BasickStatFlg": "", "Special Rating Type": "", "Targeted Min Age": "", "CDA Pageset": "", "Service Price Percent": "", "Auto Explode Flag": "N", "Pricing Details": "", "Cfg Released Flag": "Y", "ThumbnImageFileAutoUpdFlg": "", "Minimum Quantity": "", "End Date": "", "Units In Inventory As Of": "", "Parent Internal Product Id": "", "Primary Organization Id": "0-R9NH", "Network Element Type": "", "Vendor Location": "", "Compensatable": "Y", "Success Dependency": "Default", "Global Assembly Level Code": "", "ImageFileExt": "", "Complex Product Price Model Name": "", "Return if Defective": "", "Orderable": "Y", "Price List Item Integration Id": "", "CDA Pageset Id": "", "Integration Id": "88-1X5VS9", "Id": "88-1X5VS9", "Composition Type": "", "SPN Definition Name": "", "Serialized": "", "Complex Product Price Model Id": "", "Parent Internal Product Vendor Location": "", "Product Version": "", "Parent Internal Product Vendor Id": "", "Payment Type": "", "Purchase Price": "", "Price List Item End Date": "", "Format": "", "ImageFileDate": "", "Ship Flag": "N", "Position Bill Product Flag": "N", "Track As Asset Flag": "Y", "Sales Service Flag": "N", "Units per Case": "", "Description": "", "Detailed Description": "", "Item Size": "", "Image Description": "", "Case Conversion Factor": "", "MTTR": "", "Service Terms": "", "Service Flag": "N", "External Integration Id": "", "Volume Discount": "", "Targeted Max Age": "", "Object Number": "88-1X5VS9", "Configuration Model Id": "88-1X5VS9", "Dynamic Discount Method": "Amount", "SPN Definition Id": "", "Global Product Lifecycle Status Code": "", "Pack Size": "", "Accrual Rate": "", "Min Sale Price": "", "Featured": "N", "Display Component": "", "Cfg Model Id": "88-1X5VS9", "Reference Price": "", "ImageFileDeferFlg": "", "ListOfPrice List Item": { "Price List Item": [ { "Purchase Price": "", "Volume Discount End Date": "", "Min Sale Price": "", "Bundle Sequence Id": "", "Integration Id": "444", "Standard Overtime Price Percent": "", "Product Name": "SDX Data Service", "Average Cost": "", "Dynamic Matrix Id": "", "Reference Price": "", "Last Cost": "", "Pricing Method": "", "Volume Discount": "SDX Volume Discount", "End Date": "", "Description": "", "Tax Var4": "", "Override Rollup Flag": "N", "List Price Type Code": "STANDARD", "Tax Var3": "", "Service Price Percent": "", "Dynamic Matrix": "", "Tax Var2": "", "Tax Var1": "", "Price List Id": "88-23AQ7", "Cost List Item Currency Code": "USD", "Start Date": "09/22/2021 00:00:00", "Extended Overtime Price Percent": "", "Product Id": "88-1X5VS9", "Next Cost": "", "Product VOD Id": "88-1X5VSA", "Pricing Procedure": "", "Price List Currency Code": "USD", "Original List Price": "1000", "Volume Discount Method": "TIERED", "List Price": "1000", "Bundle Sequence Name": "", "Bonus Threshold": "", "Promotional Price": "", "Price Model End Date": "", "MSRP Price": "", "Volume Discount Id": "88-1X5Y5B", "External Integration Id": "", "Cost": "", "Price List Name": "CME Price List", "Max Sale Price": "", "Service Price Amount": "" } ] }, "ListOfSWI ISS Product VOD BusComp": { "SWI ISS Product VOD BusComp": [ { "VOD Id": "88-1X5VS9", "Locked By": "", "Locked Flag": "N", "Description": "", "VOD Name": "SDX Data Service", "Locked Date": "", "VOD Type": "ISS_PROD_DEF", "ListOfSWI ISS Product Details BusComp": { "SWI ISS Product Details BusComp": [ { "First Version": "1", "Class Name": "", "Parent VOD Id": "", "Orig Id": "88-1X5VSB", "SPN Definition Id": "", "Post Pick CD": "", "Object Name": "0", "XA Integration Id": "", "Object Id": "88-1X5VSA", "Pre Pick CD": "", "SPN Definition Name": "", "Parametric Search Flg": "", "Last Version": "0" } ] }, "ListOfSWI ISS Product Structure Admin BusComp": { "SWI ISS Product Structure Admin BusComp": [ { "Last Version": "0", "Prod Id": "88-1X5VNR", "Max Cardinality": "1", "Default Object Number": "", "Object Id": "88-1X5VSA", "Comments": "", "Item Name": "SDX Wireless Data", "Min Cardinality": "0", "Default Prod Id": "", "Type": "Product", "Class Name": "", "Object Number": "88-1X5VNR", "Class Id": "", "Default Cardinality": "0", "First Version": "1", "Forcastable Flag": "Y", "Orig Id": "88-1X5VTW", "Product Name": "SDX Wireless Data", "Port Id": "", "Relationship Type": "Has A", "Sequence Num": "" } ] }, "ListOfSWI ISS Product Versions BusComp": { "SWI ISS Product Versions BusComp": [ { "Version": "3", "Released Flag": "N", "VOD Id": "88-1X5VSA", "Latest Released Flag": "N", "Comments": "", "Required End Date": "", "Required Start Date": "", "Active Flg": "Y", "Version Id": "88-1X5VSC" } ] } } ] }, "ListOfSWI Internal Product Organization": { "SWI Internal Product Organization": [ { "Product Id": "88-1X5VS9", "Organization Id": "0-R9NH" } ] } } ] } }, "ProdPromDefinition": { "IntObjectFormat": "Siebel Hierarchical", "MessageId": "88-2ABAG", "IntObjectName": "ISS Promotion WS", "MessageType": "Integration Object", "ListOfISS Promotion WS": { "ISS Promotion": [ { "Configuration Model Id": "88-1XLIBC", "Period": "1", "Usage Plan Name": "", "ImageFileSDX BasickStatFlg": "", "NRC Amount": "", "NRC Amount Exchange Date": "10/12/2021 00:00:00", "RC Amount Currency Code": "USD", "Pre Pick CD": "Y", "ImageFileSDX BasickReqFlg": "", "Manual Ambiguity Resolution Flag": "N", "NRC Plan Id": "", "Id": "88-1XLIBC", "Commit Flag": "Y", "Name": "SDX Basic", "Payment Type": "", "Sales Product Flag": "Y", "ThumbnImageFileExt": "", "Adjust Charge": "", "Promotion Image Integration Id": "", "RC Amount Exchange Date": "10/12/2021 00:00:00", "End Date": "", "Description": "", "Instance": "", "Grace Period": "", "NRC Schedule": "", "RC Schedule": "", "RC Adjustment Amount": "", "ImageFileRev": "", "Start Date": "", "Usage Schedule": "", "Period UOM": "Years", "Promotion Type": "Bundled Promotions", "ThumbnImageFileSDX BasickStatFlg": "", "ImageFileSize": "", "Track As Instance Flag": "Y", "RC Adjustment U/M": "", "Track As Asset Flag": "Y", "ImageFileName": "", "NRC Plan Name": "", "NRC Schedule Id": "", "Promotion Id": "88-1XLIBC", "Position Bill Product Flag": "N", "ThumbnImageFileSize": "", "ThumbnImageFileSDX BasickReqFlg": "", "ImageFileExt": "", "Usage Plan Id": "", "Reason": "", "NRC Qty": "1", "Score": "", "Track As Agreement Flag": "Y", "ThumbnImageFileName": "", "RC Amount": "", "NRC Amount Currency Code": "USD", "ThumbnImageFileRev": "", "Grace Period UOM": "Days", "Adjust Reason": "", "Image Name": "", "Product Def Type Code": "None", "Inclusive Eligibility Flag": "N", "Usage Schedule Id": "", "Charge Basis": "Schedule", "RC Schedule Id": "", "ListOfISS Promotion Items for Import": { "ISS Promotion Items for Import": [ { "Period": "1", "IsRecommendable Flag": "Y", "Minimum Quantity": "1", "Item Name": "", "Termination Charge": "", "Id": "88-1XLIBF", "Prod Id": "88-1X5VS9", "Product Line": "", "Apply Component Charge Flag": "N", "Class VodNum": "", "Integration Id": "88-1XLIBF", "XA Modified Flag": "N", "Root Promotion Item Id": "88-1XLIBF", "Product Name": "SDX Data Service", "Is Constrained": "N", "Prorate Plan Id": "", "Description": "", "Default Cardinality": "", "Sub Obj Name": "", "Grace Period": "", "Default Quantity": "1", "Sequence": "", "Maximum Quantity": "1", "Period UOM": "Years", "Cardinality Modified Flag": "N", "Product Line Id": "", "Prod Cfg Model Id": "88-1X5VS9", "Sub Obj VOD Num": "", "Parent Promotion Item Integration Id": "", "Domain Modified Flag": "N", "Promotion Id": "88-1XLIBC", "Lower Limit": "", "Track As Agreement Flag": "N", "Prorate Plan Name": "", "Type": "Components", "Parent Promotion Item Id": "", "Product Item Id": "", "Grace Period UOM": "Days", "Upper Limit": "", "Disconnect Action": "Disconnect" }, { "Period": "1", "IsRecommendable Flag": "Y", "Minimum Quantity": "1", "Item Name": "", "Termination Charge": "", "Id": "88-1XLIBH", "Prod Id": "", "Product Line": "", "Apply Component Charge Flag": "N", "Class VodNum": "88-1X5VEB", "Integration Id": "88-1XLIBH", "XA Modified Flag": "N", "Root Promotion Item Id": "88-1XLIBH", "Product Name": "", "Is Constrained": "N", "Prorate Plan Id": "", "Description": "Product Class", "Default Cardinality": "", "Sub Obj Name": "", "Grace Period": "", "Default Quantity": "1", "Sequence": "", "Maximum Quantity": "1", "Period UOM": "Years", "Cardinality Modified Flag": "Y", "Product Line Id": "", "Prod Cfg Model Id": "", "Sub Obj VOD Num": "", "Parent Promotion Item Integration Id": "", "Domain Modified Flag": "N", "Promotion Id": "88-1XLIBC", "Lower Limit": "", "Track As Agreement Flag": "N", "Prorate Plan Name": "", "Type": "Aggregate", "Parent Promotion Item Id": "", "Product Item Id": "", "Grace Period UOM": "Days", "Upper Limit": "", "Disconnect Action": "Prompt", "ISS Promotion Items for Import": [ { "Period": "1", "IsRecommendable Flag": "Y", "Minimum Quantity": "", "Item Name": "", "Termination Charge": "", "Id": "88-1XLIBJ", "Prod Id": "88-1X5VJB", "Product Line": "", "Apply Component Charge Flag": "N", "Class VodNum": "", "Integration Id": "88-1XLIBJ", "XA Modified Flag": "N", "Root Promotion Item Id": "88-1XLIBJ", "Product Name": "SDX Mustang 11", "Is Constrained": "N", "Prorate Plan Id": "", "Description": "", "Default Cardinality": "", "Sub Obj Name": "", "Grace Period": "", "Default Quantity": "1", "Sequence": "", "Maximum Quantity": "", "Period UOM": "Years", "Cardinality Modified Flag": "N", "Product Line Id": "", "Prod Cfg Model Id": "88-1X5VJB", "Sub Obj VOD Num": "", "Parent Promotion Item Integration Id": "88-1XLIBH", "Domain Modified Flag": "N", "Promotion Id": "88-1XLIBC", "Lower Limit": "", "Track As Agreement Flag": "N", "Prorate Plan Name": "", "Type": "Aggregate Default", "Parent Promotion Item Id": "88-1XLIBH", "Product Item Id": "", "Grace Period UOM": "Days", "Upper Limit": "", "Disconnect Action": "Modify" } ] } ] }, "ListOfISS Promotion Upgrade To": { "ISS Promotion Upgrade To": [ { "Target Period UOM": "Years", "Original Period": "1", "Product Line": "", "Class VodNum": "", "Original Promotion Description": "", "Target Promotion VOD Row Id": "88-1X6ET3", "Prorate Plan Id": "", "Penalty Amount Currency Code": "USD", "Tgt End Date": "08/23/2021 10:00:00", "Original Promotion Id": "88-1XLIBC", "Original Period UOM": "Years", "Tgt Start Date": "08/23/2021 10:00:00", "Target Promotion Id": "88-1X6ET2", "Penalty Amount Exchange Date": "10/12/2021", "Tgt Released Flag": "Y", "Original Grace Period UOM": "Days", "Target Grace Period UOM": "Days", "Product Line Id": "", "Target Period": "1", "Tgt First Version": "1", "Class Name": "", "Prod Cfg Model Id": "88-1XLIBC", "Tgt Last Version": "0", "Original Promotion Name": "SDX Basic", "Commitment Start": "Original Start", "Penalty Amount": "", "Target Promotion Description": "", "Target Promotion Name": "SDX BasicOptional1", "Reason": "", "Tgt Active Flag": "Y", "Tgt Version": "1", "Prorate Plan Name": "", "Display Prorated Charge": "Y", "Original Grace Period": "", "Display Commitment": "Y", "Target Promotion Configuration Model Id": "88-1X6ET2", "Target Grace Period": "", "Relationship Type": "Upgrade", "Duration": "Original Duration" }, { "Target Period UOM": "Years", "Original Period": "1", "Product Line": "", "Class VodNum": "", "Original Promotion Description": "", "Target Promotion VOD Row Id": "88-1X6EUQ", "Prorate Plan Id": "", "Penalty Amount Currency Code": "USD", "Tgt End Date": "08/23/2021 10:00:00", "Original Promotion Id": "88-1XLIBC", "Original Period UOM": "Years", "Tgt Start Date": "08/23/2021 10:00:00", "Target Promotion Id": "88-1X6EUP", "Penalty Amount Exchange Date": "10/12/2021", "Tgt Released Flag": "Y", "Original Grace Period UOM": "Days", "Target Grace Period UOM": "Days", "Product Line Id": "", "Target Period": "1", "Tgt First Version": "1", "Class Name": "", "Prod Cfg Model Id": "88-1XLIBC", "Tgt Last Version": "0", "Original Promotion Name": "SDX Basic", "Commitment Start": "Original Start", "Penalty Amount": "", "Target Promotion Description": "", "Target Promotion Name": "SDX Ineligible Prom 4", "Reason": "", "Tgt Active Flag": "Y", "Tgt Version": "1", "Prorate Plan Name": "", "Display Prorated Charge": "Y", "Original Grace Period": "", "Display Commitment": "Y", "Target Promotion Configuration Model Id": "88-1X6EUP", "Target Grace Period": "", "Relationship Type": "Upgrade", "Duration": "Original Duration" }, { "Target Period UOM": "Years", "Original Period": "1", "Product Line": "", "Class VodNum": "", "Original Promotion Description": "", "Target Promotion VOD Row Id": "88-1X6F47", "Prorate Plan Id": "", "Penalty Amount Currency Code": "USD", "Tgt End Date": "09/23/2021 01:47:41", "Original Promotion Id": "88-1XLIBC", "Original Period UOM": "Years", "Tgt Start Date": "09/23/2021 01:44:38", "Target Promotion Id": "88-1X6F46", "Penalty Amount Exchange Date": "10/12/2021", "Tgt Released Flag": "Y", "Original Grace Period UOM": "Days", "Target Grace Period UOM": "Days", "Product Line Id": "", "Target Period": "1", "Tgt First Version": "1", "Class Name": "", "Prod Cfg Model Id": "88-1XLIBC", "Tgt Last Version": "0", "Original Promotion Name": "SDX Basic", "Commitment Start": "Original Start", "Penalty Amount": "", "Target Promotion Description": "", "Target Promotion Name": "SDX BasicOptional2", "Reason": "", "Tgt Active Flag": "Y", "Tgt Version": "1", "Prorate Plan Name": "", "Display Prorated Charge": "Y", "Original Grace Period": "", "Display Commitment": "Y", "Target Promotion Configuration Model Id": "88-1X6F46", "Target Grace Period": "", "Relationship Type": "Upgrade", "Duration": "Original Duration" } ] }, "ListOfProduct Eligibility BusComp": { "Product Eligibility BusComp": [ { "Product Class": "", "Effective End Date": "", "Product Id": "88-1XLIBC", "Product Line Id": "", "Country": "", "External Integration Id": "", "Matrix Rule Num": "296-116897025", "Account Name": "", "Type": "Not Available", "Product Line": "", "Post Code To": "", "State": "AK", "Exchange Prefix": "", "Adjustment Group Id": "88-1X5Y23", "Post Code From": "", "Product": "SDX Basic", "Effective Start Date": "", "Product Class Id": "", "Account Type Code": "", "Account Id": "", "Eligibility Status": "N", "City": "" } ] } } ] } }, "PromDomainProduct": { "IntObjectFormat": "Siebel Hierarchical", "MessageId": "", "IntObjectName": "PDS Product Interface", "MessageType": "Integration Object", "ListOfPDS Product Interface": { "Product": [] } }