Performing an Order Checkout

When you use the Siebel REST API to checkout an order, the Siebel application calculates pricing, checks eligibility, and verifies the promotion on the given order structure. All operations are performed in memory. When the customer confirms the order and the SyncOrderFlag flag is set, then the order is created in Siebel CRM.

The following request performs an order checkout:

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": "Web Channel Ordering Workflow",
		"PricingFlag": "Y",
		"CheckEligibilityFlag": "Y",
		"SyncOrderFlag": "Y",
		"VerifyPromotionFlag": "N",
		"RepricingFlag": "Y",
		"OrderIO": {
			"MessageId": "",
			"MessageType": "Integration Object",
			"IntObjectName": "PDS Order",
			"IntObjectFormat": "Siebel Hierarchical",
			"ListOfPDS Order": {
				"Header": {
					"Account Id": "1-63Q9",
					"Account": "3Com",
					"Id": "0CX-1W1W9Y3",
					"Price List Id": "88-23AQ7",
					"Revision": "1",
					"Account Type": "Residential",
					"Order Number": "Test_OWS_sl3",
					"Currency Code": "USD",
					"Order Type": "Sales Order"
				}
			}
		}
	}
}

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

Name	Description
Process Name	The following process is required: Web Channel Ordering Workflow
OrderIO	Required. Order structure based on the PDS Order IO.
CheckEligibilityFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers the eligibility and compatibility check sub-process.
PricingFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers the Repricing step on the OrderIO.
SyncOrderFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers the Synch Order operation.
VerifyPromotionFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers the Verify the Order’s Promotions step for an existing order on Siebel CRM.
QueryOrderFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers another query to the Order step, which returns the updated OrderIO to the requesting application.
RepricingFlag	Optional. The default value is N. If the value is set to Y, then this flag triggers the Reprice step a second time after any updates have been made for an existing order in Siebel CRM.

Here are the response details for a successful request:

HTTP Code: 200
Content-Type: application/json

Response body:

    	     {
	"Error Code": "",
	"Process Instance Id": "88-1XBZA3",
	"Error Message": "",
	"OrderIO": {
		"IntObjectFormat": "Siebel Hierarchical",
		"MessageId": "",
		"IntObjectName": "PDS Order",
		"MessageType": "Integration Object",
		"Header": {
			"Mod Id": "0",
			"Discount": "",
			"Opty Id": "",
			"Conflict Id": "0",
			"Updated": "03/30/2021 12:11:35",
			"Order Number": "Test_OWS_sl3",
			"Revision": "1",
			"Integration Id": "88-1XBZAE",
			"Price List Id": "88-23AQ7",
			"Status": "Pending",
			"Account": "3Com",
			"Order Type": "Sales Order",
			"Id": "88-1XBZAE",
			"Created": "03/30/2021 12:11:33",
			"Contact Id": "1-6S9M",
			"Account Location": "HQ-Distribution",
			"Account Id": "1-63Q9",
			"Currency Code": "USD"
		}
	}
}