Suspending a Promotion

When you use the Siebel REST API to suspend a promotion, the Siebel application suspends an existing promotion asset that was previously active. All promotion components are suspended in addition to the promotion.

The following request suspends 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 for Order:
     {
    	"body": {
    		"ProcessName": "SISOMSuspendWebService-Quote",
    		"AccountId": "88-1VG0YB",
    		"Sync": "Y",
    		"AssetIntegrationId": "88-1VG0YU"
    	}
    }

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

Name Description

Process Name

One of the following processes is required:

  • SISOMSuspendWebService-Quote

  • SISOMSuspendWebService-Order

Asset Integration Id

Required.

Integration ID of the bundle promotion asset you want to suspend.

Account Id

Required.

Account ID associated with the asset.

Sync

Optional. The default value is Y.

If Sync is N, quote or order is created in-memory and sent as response without committing to the database.

If Sync is Y or omitted in the request, existing behavior of database commit continues.

Here are the response details for a successful request:

  • HTTP Code: 200

  • Content-Type: application/json

  • Response body:
        	            {
    	"ActiveDocumentId": "88-1VI735",
    	"Error Code": "",
    	"Error Message": "",
    	"SiebelMessage": {
    		"IntObjectFormat": "Siebel Hierarchical",
    		"MessageId": "88-22F13",
    		"IntObjectName": "PDS Quote",
    		"MessageType": "Integration Object",
    		"Header": {
    			"Status": "In Progress",
    			"Id": "88-1VI735",
    			"Name": "88-1VI735",
    			"Quote Number": "88-1VI735",
    			"Line Item": [
    				{
    					"Product Structure Type": "None",
    					"Product Type Code": "Promotion",
    					"Name": "Millennium Max 500 Package",
    					"Asset Integration Id": "88-1VG0YU",
    					"Action Code": "Suspend",
    					"Id": "88-1VI73U"
    				}
    			]
    		}
    	}
    }