130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2
|
|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
|
|
| ProductPromotionEntry |
| Overview | |
| Service URL: | https://app.kognitivloyalty.com/Services/Mobile.asmx (Production) |
| Service WSDL URL: | https://app.kognitivloyalty.com/Services/Mobile.asmx?WSDL (Production) |
| Method: | ProductPromotionEntry |
| Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/Mobile.asmx?op=ProductPromotionEntry (Production) |
| Description: | Processes a Product Code Promotion Entry from a Mobile Device using Phone Number to Id the Account. |
| Interface | |
| Input Parameters: | Takes parameter 'preqProductPromotionEntry' of type 'reqProductPromotionEntry' (defined below) |
| Returns: | Returns record of type 'respProductPromotionEntry' (defined below) |
| Type: | reqProductPromotionEntry |
| Field: | SecurityToken (String) - Web Service Security Token generated via the Aimia Loyalty Solutions Platform Application |
| Field: | LoyaltyProgramId (Required)(Integer) - The Loyalty Program Id to validate (Hardcoded value for the specific Loyalty Program) |
| Field: | LocationExternalReference (String) - This is the External Reference for the Location that the Transaction should be applied to |
| Field: | PhoneNumber (Required)(String) - The Phone Number to Lookup, Requires Country Code (1 for US). All Non-Numbers are 'stripped', so this can be formatted or unformatted |
| Field: | ProductCode (String) - The actual Product Code being Entered |
| Type: | respProductPromotionEntry |
| Field: | ReturnCode (Interger) - Contains Return Code - possible values defined in 'Error Codes' section of this page |
| Field: | ErrorMessage (String) - Blank if not 'Success', otherwise, String representation of the Return Code Error |
| Field: | SuccessfulPromotionMessage (String) - If the Promotion is Successful, the Product Code Promotion will return back a "Successful String Message" |
| Field: | MemberFirstName (String) - Member First Name, Blank if Non Success Return Code |
| Field: | MemberLastName (String) - Member LastName, Blank if Non Success Return Code |
| Field: | LoyaltyProgramName (String) - The Proper Loyalty Program Name, Blank if Non Success Return Code |
| Field: | PointsEarned (Double / Floating Point) - The Total Points Earned, Zero if Non Success Return Code |
| Field: | PointsUsed (Double / Floating Point) - The Total Points Used for Rewards, Zero if Non Success Return Code |
| Field: | PointsDeducted (Double / Floating Point) - The Total Points Deducted due to Negative Point Transactions (maybe refunds), Zero if Non Success Return Code |
| Field: | PointsExpired (Double / Floating Point) - The Total Points Expired, Zero if Non Success Return Code |
| Field: | PointsLocked (Double / Floating Point) - The Total Points Locked, Zero if Non Success Return Code |
| Field: | PointsAvailable (Double / Floating Point) - The Total Points Available for Redemption, Zero if Non Success Return Code |
| 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 (303) - Invalid Loyalty Program Id (305) - Member is Not Enrolled in Loyalty Program (1000) - No Account for Phone Number (1001) - Promotion Procecssing Error (See the ErrorMessage Field for Details) (1002) - Invalid Location External Reference |
| Reference | |
| click for: | Web Services Overview |
| link: | Web Services Map |
| link: | SBLP Security Token Information |
|
Copyright © 2003-2021 Kognitiv, Corp. All rights reserved. |