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

LoyaltyRedemptionService


Use this Web service with the Siebel Loyalty application to perform all redemption related operations, including redemption processing, redemption cancellation, voucher reissue, and Siebel Order Management integration.

LoyaltyRedemptionService Operations

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

Table 300. LoyaltyRedemptionService Operations
Name
Description

GetPriceOptions

Returns available price options for a set of redemption activities. Also returns the point balance of the member in all point types.

GetPriceOptions

Returns available price options with payment mode set as Points or Points+Pay for a set of redemption activities. Also returns the point balance of the member in all point types.

CheckPriceOptions

Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service performs the point-to-pay conversion and returns the prorated pay and points for each transaction.

CheckCredit

Performs the credit check for a given member and point type. Checks whether a loan is required and returns how much of a loan is required to fulfill the redemption transaction.

GetQuote

Returns available price options for a set of redemption activities. Also performs the credit check and returns how much of a loan is required for each point type. If a loan is not possible, then the Web service does the point-to-pay conversion and returns the prorated pay and points for each transaction.

This operation also creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional).

ProcessQuote

Takes Quote ID as input and converts the quote to order and order to redemption transactions, then processes those transactions.

GetTransactionDetails

Takes as input an Order Number and returns the Transaction details (including activities and Transaction Items if any) for the same.

GetRedemptionRefund

Returns the refund in Points or Points plus Pay for a given redemption transaction, which need to be cancelled.

CancelRedemptionTxn

Takes the redemption transaction ID which need to be cancelled and the refund amount (either unmodified, or overridden refund amount got from the GetRedemptionRefund method) and creates the cancellation transaction and processes it.

GetReissueFeeOptions

Returns the different fee options for reissuing the given voucher.

CheckReissueFeeOption

Checks whether a given fee option for a voucher is valid, and whether the member has enough points to pay in this fee option if the payment mode involves Points.

GetReissueQuote

Takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data.

ProcessReissueQuote

Takes as input Quote ID, creates Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher.

UpdateQuoteShippingAddress

Takes Quote ID and shipping details and updates the quote with the given shipping address.

AddCreditCardToQuote

Takes Quote ID, credit card details, billing address and updates the quote with the credit card details.

ProcessRealTimeRedemption

Takes as input the transaction data. It checks all pending redemption transactions and verifies the point balance to determine whether the request can be processed. The service also performs a credit check to determine whether a loan is needed for processing the transaction. If a loan is needed, the service creates and processes the loan transaction, and then creates the redemption transaction. It returns the transaction number as output.

Request Message Description: GetPriceOptions

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

Table 301. Request Message Description: GetPriceOptions
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details.

Integration Object (Required)

Response Message Description: GetPriceOptions

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

Table 302. Response Message Description: GetPriceOptions
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details and the price options for each activity.

Integration Object (Required)

LOY Redemp Points Summary

Contains point balances of the member in all point types.

Integration Object (Required)

Request Message Description: CheckPriceOptions

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

Table 303. Request Message Description: CheckPriceOptions
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details.

Integration Object (Required)

Response Message Description: CheckPriceOptions

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

Table 304. Response Message Description: CheckPriceOptions
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details and one price option for each activity.

Integration Object

LOY Redemp Points Summary

Point summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag.

Integration Object

Pay

Total amount to be paid if monetary payment is involved.

Number

Pay Currency Code

Currency if monetary payment is involved.

String

Request Message Description: CheckCredit

This operation performs a credit check for a given member and point type. Checks whether loan is required and returns how much of a loan is required to fulfill the redemption transaction. For a description of this request message, see Table 305.

Table 305. Request Message Description: CheckCredit
Node
Description
Type

MemberNumber

Membership number.

String

PointTypeId

ID number for point type.

String

PointsReq

The required number of points.

Number

LoanFlag

Indicates whether loan limit must be considered.

String

Response Message Description: CheckCredit

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

Table 306. Response Message Description: CheckCredit
Node
Description
Type

CCResult

Required

String

Available Balance

Required

String

EligLoan

Optional

Number

Error Message

Optional

String

LoanAllowed

Required

String

LoanFlag

Optional

String

PointsShortage

Optional

String

Request Message Description: GetQuote

This operation creates a quote using the given redemption activities (transactions), credit card details (optional) and shipping details (optional). For a description of this request message, see Table 307.

Table 307. Request Message Description: GetQuote
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details.

Integration Object

Billing Address

Address of customer being billed.

String

Billing Address2

Second address, if necessary of customer being billed.

String

Shipping Method

Shipping method, such as Ground, Air or carrier name.

String

Ship To Street Address

Shipping street address.

String

Ship To Street Address 2

Second shipping street address if needed.

String

Ship To State

Shipping state.

String

Ship To Postal Code

Shipping postal code.

String

Ship To Country

Shipping country.

String

Billing City

Billing city, if different from shipping address.

String

Billing Country

Billing country, if different from shipping address.

String

Billing State

Billing state, if different from shipping address.

String

Billing ZIP Code

Billing ZIP code, if different from shipping address.

String

CVV Number

CVV number of the credit card.

String

Card Holder Name

Name of credit card holder.

String

Credit Card Expiration Month

Expiration date of credit card.

String

Credit Card Expiration Year

Expiration year of credit card.

String

Credit Card Line Number

Credit card line number.

String

Credit Card Number

Credit card number.

String

Credit Card Type

Credit cards type, such as Visa, American Express, and so on.

String

Recipient Name

Name of person who will receive shipped goods.

String

Save Shipping Address Flag

Check to save shipping address for future use.

String

Select Primary Shipping Address Flag

Flag to indicate primary address for account.

String

Ship To Address Id

ID for shipping address.

String

Ship To City

City that product is being shipped to.

String

Response Message Description:GetQuote

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

Table 308. Response Message Description:GetQuote
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details and one price option for each activity.

Integration Object

LOY Redmp Points Summary

Point Summary for each point type including points to be paid, point balance, loan (if any) and Points to Pay Conversion flag.

Integration Object

Currency Code

Code to indicate which currency being used for translation.

String

Shipping Charge

Shipping charge for transaction.

String

Quote Id

ID of quote that is created.

String

Pay

Total amount of transaction.

Number

Tax

Total taxed charged on transaction.

Number

Request Message Description: ProcessQuote

This operation converts a quote to an order and an order to redemption transactions. It then processes these transactions.

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

Table 309. Request Message Description: ProcessQuote
Node
Description
Type

Quote Id

String

Required

Response Message Description: Process Quote

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

Table 310. Response Message Description: Process Quote
Node
Description
Type

Status

Optional

String

Order Id

Required

String

Request Message Description: GetTransactionDetails

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

Table 311. Request Message Description: GetTransactionDetails
Node
Description
Type

Order Number

Required

String

Response Message Description: GetTransactionDetails

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

Table 312. Response Message Description: GetTransactionDetails
Node
Description
Type

LOY Redemption Txn

Contains details of the redemption transactions that have been created for this order along with transaction items for each transaction in case of package transaction.

Integration Object.

Request Message Description: GetRedemptionRefund

This operation returns the refund amount for given redemption transaction, which is then cancelled. For a description of this request message, see Table 313.

Table 313. Request Message Description: GetRedemptionRefund
Node
Description
Type

Transaction Id

Required

String

Response Message Description: GetRedemptionRefund

Table 314. Response Message Description: GetRedemptionRefund
Node
Description
Type

Pay

Optional

String

Point Type

Required

String

Points

Required

String

Currency

Optional

String

Payment Type

Required

String

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

Request Message Description: CancelRedemptionTxn

This operation takes the redemption transaction ID which requires cancellation as well as the refund amount (either the unmodified or overridden refund amount gotten from the GetRedemptionRefund operation) and creates the cancellation transaction and processes it. For a description of this request message, see Table 315.

Table 315. Request Message Description: CancelRedemptionTxn
Node
Description
Type

Override Expiry Date

Optional

String

Override Expiry Date Flag

Optional

String

Override Pay

Optional

String

Override Points

Optional

String

Override Price Flag

Optional

String

Transaction Id

Required

String

Override Reason Code

Optional

String

Payment Mode

Required

String

Simulate Pay

Optional

String

Override Reason

Optional

String

Response Message Description:CancelRedemptionTxn

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

Table 316. Response Message Description:CancelRedemptionTxn
Node
Description
Type

New Txn Id

ID of the cancelled transaction.

String

Request Message Description: GetReissueFeeOptions

This operation returns available fee options for reissue of a voucher with given ID. For a description of this request message, see Table 317.

Table 317. Request Message Description: GetReissueFeeOptions
Node
Description
Type

Currency Code

Optional

String

Voucher Id

Required

String

Point Type Id

Optional

String

Payment Type Code

Required

String

Response Message Description:GetReissueFeeOptions

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

Table 318. Response Message Description:GetReissueFeeOptions
Node
Description
Type

Product Point Id

Required

String

Fee Points

Optional

Number

Fee Amount

Optional

Number

Error Message

Optional

String

Request Message Description: GetReissueQuote

This operation takes the chosen fee option details for a voucher, credit card details (optional), shipping details (optional), checks whether the fee option is valid, does credit check if the payment mode involves points, and creates a quote with the given data. For a description of this request message, see Table 319.

Table 319. Request Message Description: GetReissueQuote
Node
Description
Type

Voucher Id

Required

String

Currency Code

Optional

String

Payment Type Code

Required

String

Point Type Id

Optional

String

Override Amount

Optional

Number

Override Flag

Optional

String

Override Points

Optional

Number

Override Reason

Optional

String

Override Reason Code

Optional

String

Billing Address

Optional

String

Billing Address2

Optional

String

Shipping Method

Optional

String

Ship To Street Address 2

Optional

String

Ship To Street Address

Optional

String

Ship To State

Optional

String

Ship To Postal Code

Optional

String

Ship To Country

Optional

String

Billing City

Optional

String

Billing Country

Optional

String

Billing State

Optional

String

Billing ZIP Code

Optional

String

CVV Number

Optional

String

Card Holder Name

Optional

String

Credit Card Expiration Month

Optional

String

Credit Card Expiration Year

Optional

String

Credit Card Number

Optional

String

Credit Card Type

Optional

String

Recipient Name

Optional

String

Save Shipping Address Flag

Optional

String

Select Primary Shipping Address Flag

Optional

String

Ship To Address Id

Optional

String

Ship To City

Optional

String

Response Message Description: GetReissueQuote

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

Table 320. Response Message Description: GetReissueQuote
Node
Description
Type

Currency Code

Optional

String

Quote Id

Required

String

Error Message

Optional

String

Fee Amount

Optional

Number

Fee Points

Optional

Number

Shipping Charge

Optional

String

Tax Amount

Optional

String

Currency Code

Optional

String

Request Message Description: ProcessReissueQuote

This operation takes as input Quote ID, creates and Order for Quote, and creates a Loyalty Voucher Reissue transaction and processes it to reissue the voucher. For a description of this request message, see Table 321.

Table 321. Request Message Description: ProcessReissueQuote
Node
Description
Type

Quote Id

Required

String

Response Message Description: ProcessReissueQuote

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

Table 322. Response Message Description: ProcessReissueQuote
Node
Description
Type

Transaction Number

Required

String

Order Number

Required

String

New Voucher Expiry Date

Required

Date

New Voucher Number

Required

String

New Voucher Status

Required

String

Request Message Description: UpdateQuoteShippingAddress

This operation takes the Quote ID and shipping details and updates the quote with the given shipping address. For a description of this request message, see Table 323.

Table 323. Request Message Description: UpdateQuoteShippingAddress
Node
Description
Type

Quote Id

Required

String

Response Message Description: UpdateQuoteShippingAddress

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

Table 324. Response Message Description: UpdateQuoteShippingAddress
Node
Description
Type

Shipping Charge

Required

String

Request Message Description: AddCreditCardToQuote

This operation takes the Quote ID, credit card details, billing address and updates the quote with the credit card details. For a description of this request message, see Table 325.

Table 325. Request Message Description: AddCreditCardToQuote
Node
Description
Type

Billing Address

Required

String

Billing Address 2

Optional

String

Billing City

Optional

String

Billing Country

Required

String

Billing ZIP Code

Optional

String

CVV Number

Optional

Number

Card Holder Name

Optional

String

Credit Card Number

Optional

Number

Credit Card Type

Optional

String

Expiration Month

Optional

String

Expiration Year

Optional

String

Response Message Description: GetReissueQuote

There are no response messages for this operation.

Request Message Description: ProcessRealTimeRedemption

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

Table 326. Request Message Description: ProcessRealTimeRedemption
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details.

Integration Object

Response Message Description: ProcessRealTimeRedemption

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

Table 327. Response Message Description: ProcessRealTimeRedemption
Node
Description
Type

LOY Redemption Txn

Contains the redemption activity details.

Integration Object

Transaction Number

Required.

String

Example Packages for LoyaltyRedemptionService

To view an example of messages 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.

Request (GetPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetPriceOptions_request.xml

Response (GetPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetPriceOptions_response.xml

Request (CheckPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckPriceOptions_request.xml

Response (CheckPriceOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckPriceOptions_response.xml

Request (CheckCredit)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckCredit_request.xm

Response (CheckCredit)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CheckCredit_response.xml

Request (GetQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetQuote_request.xml

Response (GetQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetQuote_response.xml

Request (ProcessQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessQuote_request.xml

Response (ProcessQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessQuote_response.xml

Request (GetTransactionDetails)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetTransactionDetails_request.xml

Response (GetTransactionDetails)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetTransactionDetails_response.xml

Request (GetRedemptionRefund)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetRedemptionRefund_request.xml

Response (GetRedemptionRefund)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetRedemptionRefund_response.xml

Request (CancelRedemptionTxn)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CancelRedemptionTxn_request.xml

Response (CancelRedemptionTxn)

See the following file to view the sample code:

...\LoyaltyRedemptionService\CancelRedemptionTxn_response.xml

Request (GetReissueFeeOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueFeeOptions_request.xml

Response (GetReissueFeeOptions)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueFeeOptions_response.xml

Request (GetReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueQuote_request.xml

Response (GetReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\GetReissueQuote_response.xml

Request (ProcessReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessReissueQuote_request.xml

Response (ProcessReissueQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessReissueQuote_response.xml

Request (UpdateQuoteShippingAddress)

See the following file to view the sample code:

...\LoyaltyRedemptionService\UpdateQuoteShippingAddress_request.xml

Response (UpdateQuoteShippingAddress)

See the following file to view the sample code:

...\LoyaltyRedemptionService\UpdateQuoteShippingAddress_response.xml

Request (AddCreditCardToQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\AddCreditCardToQuote_request.xml

Response (AddCreditCardToQuote)

See the following file to view the sample code:

...\LoyaltyRedemptionService\AddCreditCardToQuote_response.xml

Request (ProcessRealTimeRedemption)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessRealTimeRedemption_request.xml

Response (ProcessRealTimeRedemption)

See the following file to view the sample code:

...\LoyaltyRedemptionService\ProcessRealTimeRedemption_response.xml

Interface Description (WSDL) for LoyaltyRedemptionService

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.

...\LoyaltyRedemptionService\LoyaltyRedemptionService.wsdl

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