Bookshelf Home | Contents | Index | PDF     

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

LoyaltyAccrualService

Use this Web service with Siebel Loyalty to perform operations on orders, including processing, importing from an external file, importing transactions, and exporting promotions.

LoyaltyAccrualService Operations

For a list of operations associated with this Web service, see Table 256.

Table 256. LoyaltyAccrualService Operations
Name
Description

ProcessExternalOrder

Process all the transactions with the given order number.

ImportExternalOrderTxn

Imports the transactions from an external file, assigns the given order number to the files, and processes all the transactions.

ProcessExternalOrderTxn

Imports the transactions from given input, stamps the transaction with an order number, and processes all the transactions. The request mode can be either Process, or Simulate.

ProcessSocialActionTxn

Captures customers' social actions (such as checkins, Tweets, shares and so on) and processes their rewards in Siebel Loyalty. This operation automatically creates a new transaction for a referral reward based on the referee's purchase transaction. Rewards are on a one-time and recurring basis.

ExportPromotions

Exports the promotion of given program.

CancelOrder

Cancels all the transactions in a given order.

Request Message Description: ProcessExternalOrder

For a description of this request message, see Table 257.

Table 257. Request Message Description: ProcessExternalOrder
Node
Description
Type

Order Number - Number

The number of transactions this order number will be processed.

Number

Response Message Description: ProcessExternalOrder

For a description of this response message, see Table 258.

Table 258. Response Message Description: ProcessExternalOrder
Node
Description
Type

Total Points

Total number of points for a given order.

Number

Request Message Description: ImportExternalOrderTxn

For a description of this request message, see Table 259.

Table 259. Request Message Description: ImportExternalOrderTxn
Node
Description
Type

File Name

File name that contains the transactions.

String.

Response Message Description: ImportExternalOrderTxn

For a description of this response message, see Table 260.

Table 260. Response Message Description: ImportExternalOrderTxn
Node
Description
Type

Total Points

Total number of points for a given order.

Number

Siebel Message

Siebel Message of transactions.

Hierarchy

Request Message Description: ProcessExternalOrderTxn

Imports the transactions from an external file, assigns the given order number to the files, and processes all the transactions. The Request Mode can be either Process or Simulate. For a description of this request message, see Table 261.

Table 261. Request Message Description: ProcessExternalOrderTxn
Node
Description
Type

Order Number

Order Number to be stamped to the saved transactions.

Number

Total Lines

Total number of transactions in the Input.

Number

Request Mode

Possible modes are Process or Simulate.

String

LOY EAI Transactions

Transactions in integration object format.

Integration Object

Response Message Description: ProcessExternalOrderTxn

For a description of this response message, see Table 262.

Table 262. Response Message Description: ProcessExternalOrderTxn
Node
Description
Type

Total Points - Number

Total number of points for the given order.

Number

Return Value - String

Possible values are Failure, or Success.

String

Siebel Message - Hierarchy

Siebel message of transactions.

Hierarchy

Request Message Description: ProcessSocialActionTxn

For a description of this request message, see Table 263.

Table 263. Request Message Description: ProcessSocialActionTxn
Node
Description
Type

SiebelMessage

One or more transactions in integration object format.

Integration Object

Response Message Description: ProcessSocialActionTxn

For a description of this response message, see Table 264.

Table 264. Response Message Description: ProcessSocialActionTxn
Node
Description
Type

ErrorArgs

Error message of each transaction.

Hierarchy

Siebel Message - Hierarchy

Processing information of transactions in the LOY EAI Transaction integration object format.

Hierarchy

Request Message Description: ExportPromotions

Exports the promotion of given program. For a description of this request message, see Table 265.

Table 265. Request Message Description: ExportPromotions
Node
Description
Type

Activity Date

Date needs to be between the start and end date of the promotion.

String

Export Flag

Export flag can be Y or N.

String

Program Name

Program name to which the user must export the promotions.

String

Response Message Description: ExportPromotions

For a description of this response message, see Table 266.

Table 266. Response Message Description: ExportPromotions
Node
Description
Type

Siebel Message

All the promotions in LOY EAI Promotion integration object format.

Integration Object.

Request Message Description: CancelOrder

For a description of this request message, see Table 267.

Table 267. Request Message Description: ExportPromotions
Node
Description
Type

LOY Cancel Order Transaction

An instance of the integration object LOY Cancel Order Transaction.

Integration Object

Order Number

The order number of the order to be cancelled.

Number.

Response Message Description: CancelOrder

For a description of this response message, see Table 268.

Table 268. Response Message Description: ExportPromtions
Node
Description
Type

LOY Cancel Order Transaction

An instance of the integration object LOY Cancel Order Transaction.

Integration Object

Order Number

The order number of the order to be cancelled.

Number.

Example of Package for LoyaltyAccrualService

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on the Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Then extract the files in the zip file.

Request

See the following file to view the sample code:

...\LoyaltyAccrualService\ProcessExternalOrder_request.xml

...\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml

...\LoyaltyAccrualService\RequestMode_Simulate_request.xml

...\LoyaltyAccrualService\ProcessExternalOrderTxn_request.xml

...\LoyaltyAccrualService\ExportPromotions_request.xml

Response

See the following file to view the sample code:

...\LoyaltyAccrualService\ProcessExternalOrder_response.xml

...\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml

...\LoyaltyAccrualService\RequestMode_Simulate_response.xml

...\LoyaltyAccrualService\ProcessExternalOrderTxn_response.xml

...\LoyaltyAccrualService\ExportPromotions_response.xml

Interface Description (WSDL) for LoyaltyAccrualService

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

WSDL (ProcessExternalOrder)

...\LoyaltyAccrualService\ProcessExternalOrder.wsdl

WSDL (ImportExternalOrderTxn)

...\LoyaltyAccrualService\ImportExternalOrderTxn.wsdl

WSDL (ProcessExternalOrderTxn)

...\LoyaltyAccrualService\ProcessExternalOrderTxn.wsdl

WSDL (ExportPromotions)

...\LoyaltyAccrualService\ExportPromotions.wsdl

      
Siebel CRM Web Services Reference Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.