130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2
|
|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
|
|
| ReturnOfferCodesExt |
| Overview | |
| Service URL: | https://app.kognitivloyalty.com/Services/SAPInterface.asmx (Production) |
| Service WSDL URL: | https://app.kognitivloyalty.com/Services/SAPInterface.asmx?WSDL (Production) |
| Method: | ReturnOfferCodesExt |
| Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/SAPInterface.asmx?op=ReturnOfferCodesExt (Production) |
| Description: | Returns Reward Offer Codes and Coupon Offer Codes - Process Transaction if No Offers are Present |
| Interface | |
| Input Parameters: | psSecurityToken (Required)(String) - Web Service Security Token created using the Kognitiv Loyalty Application |
| psTransactionUniqueId (Required)(String) - Unique POS Transaction Id for this Session | |
| pdTransactionAmount (Required)(Double) - Amount of Transaction to be Processed - Format of 0.00 - Decimnal is Optional | |
| Returns: | Returns record of type 'respReturnOfferCodesExt' (defined below) |
| Type: | respReturnOfferCodesExt |
| Field: | ReturnCode (Integer) - (0) - Success / (Non-Zero) - Error (See Below) |
| Field: | ReturnDescription (String) - Blank if not 'Success', otherwise, String representation of the Return Code Error |
| Field: | MemberId (Integer) - Internal Unique Loyalty Member Id |
| Field: | RewardOfferCode (Array of recRewardOfferCodePair) - See Record Structure Below |
| Field: | CouponOfferCode (Array of recCouponOfferCodePair) -See Record Structure Below |
| Field: | SmartButtonTransactionId (Long) - Unique Smart Button Transaction Id - May be -1 if no transaction was issued. |
| Field: | PointsEarnedForTransaction (Doube) - Points Awarded for this transaction - May be 0 if no transaction was issued. |
| Field: | TotalPointsAvailable (Double) - Total Points Available (includes this transaction) - May be 0 if no transaction was issued. |
| Field: | PrimaryAccountId (String) - Member's Primary Loyalty Account Id |
| Field: | Message (String) - Message to be displayed or printed to Member |
| Type: | recRewardOfferCodePair |
| Field: | MemberRewardId(Integer) - Internal Unique Member Issued Reward Id |
| Field: | RewardOfferCode(String) - Codes Set in Kognitiv Loyalty Application during Reward Setup (I.e. UPC) - May be Blank |
| Type: | recCouponOfferCodePair |
| Field: | MemberCouponId(Integer) - Internal Unique Member Issued Coupon Id |
| Field: | CouponOfferCode(String) - Codes Set in Kognitiv Loyalty Application during Coupon Setup (I.e. UPC) - May be Blank |
| Additional Information | |
| Notes: | |
| Error Codes | |
| Possible Return Codes: |
(0) - Sucess (1) - Undefined Error (Please Contact Support) (100) - Invalid Security Token (101) - Invalid Permission for Method (302) - Member Account is Suspended (1400) - Transaction Id Not Found (1401) - Inactive Account Id Used (1402) - Transaction Not Valid For Loyalty (1403) - No Loyalty Member Selected From Cashier Portal |
| Reference | |
| click for: | Web Services Overview |
| link: | Web Services Map |
| link: | SBLP Security Token Information |
|
Copyright © 2003-2021 Kognitiv, Corp. All rights reserved. |