Deleting an Item in a Promotion

When you use the Siebel REST API to delete an item in a promotion, the Siebel application deletes a product from an existing promotion instance either in a quote or in an order. This promotion could be the one you created in Applying a Promotion to a Quote or an Order, or, it could be an existing promotion that is being modified. This API is primarily used to remove optional components, and throws an error message when the deleted item violates the minimum cardinality. If a component level commitment is defined, then deleting the component adds penalty charges to the response.

The following request deletes an item in a 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 Edit Promotion WS - Delete Item Process",
  		"Header Id": "88-1W2C59",
  		"Siebel Operation Object Id": "88-1W2C60",
  		"Target Document": "Order",
  		"CheckPricingEligibilityFlag": "Y",
  		"Sync": "N"
  	}
  }
  

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 Edit Promotion WS - Delete Item Process
Header Id	Optional, depending on usage. However, this is required if SiebelMessage is not provided. Quote ID or Order ID
Siebel Operation Object Id	Required. Row ID of the quote item or order item that is being deleted.
Target Document	Required. Quote or Order.
SiebelMessage	Optional, depending on usage. However, this is required if HeaderId is not provided. PDS quote or PDS order.
Sync	Optional. The default value is N. If set to Y, then the order or quote is created or updated in the database.
CheckPricingEligibilityFlag	Optional. The default value is N. If set to Y, then the Pricing and Eligibility procedure is executed with EligibilityMode set to default value of 1.

Here are the response details for a successful request:

• HTTP Code: 200

• Content-Type: application/json

• Response body:

      	            {
  	"Error Code": "",
  	"Siebel Operation Object Id": "88-1W1BSC",
  	"Process Instance Id": "88-1W10NP",
  	"Error Message": "",
  	"Object Id": "",
  	"SiebelMessage": {
  		"IntObjectFormat": "Siebel Hierarchical",
  		"MessageId": "",
  		"IntObjectName": "PDS Quote",
  		"MessageType": "Integration Object",
  		"Header": {
  			"Id": "88-1W2C59",
  			"Line Item": [
  				{
  					"Asset Integration Id": "88-1W2BYU",
  					"Action Code": "Delete",
  					"Product Type Code": "Product",
  					"Prod Prom Name": "Millennium Max 500 Package",
  					"Id": "88-1W2C60",
  					"Prod Prom Id": "88-231OB",
  					"Name": "Daytech 300",
  					"Product Id": "88-231F2",
  					"Line Item": [
  						{
  							"Product Type Code": "Product",
  							"Id": "88-1W2C61",
  							"Name": "Charger",
  							"Product Id": "3SIA-2MOYY"
  						}
  					]
  				},
  				{
  					"Product Type Code": "Promotion",
  					"Id": "88-1W2C6O",
  					"Name": "Millennium Max 500 Package",
  					"Product Id": "88-231OB"
  				}
  			]
  		}
  	}
  	}