130 Weber St. W., Suite 100,
Kitchener, Ontario CANADA N2H 4A2
|
|
Kognitiv 130 Weber St. W., Suite 100, Kitchener, Ontario CANADA N2H 4A2 |
|
|
|
| RedeemCouponOffer |
| Overview | |
| Service URL: | https://app.kognitivloyalty.com/Services/PointOfSale.asmx (Production) |
| Service WSDL URL: | https://app.kognitivloyalty.com/Services/PointOfSale.asmx?WSDL (Production) |
| Method: | RedeemCouponOffer |
| Sample SOAP Packets: | https://app.kognitivloyalty.com/Services/PointOfSale.asmx?op=RedeemCouponOffer (Production) |
| Description: | Fetches Point-Of-Sale Coupon Offers |
| Interface | |
| Input Parameters: | Takes parameter 'preqRedeemCouponOffer' of type 'reqRedeemCouponOffer' (defined below) |
| Returns: | Returns record of type 'respRedeemCouponOffer' (defined below) |
| Type: | reqRedeemCouponOffer |
| Field: | SecurityToken (String) Required - Web Service Security Token generated via the Aimia Loyalty Solutions Platform Application |
| Field: | AccountId (String) Required - Loyalty Card Number or other 'account id' |
| Field: | LocationExternalRef (String) Required - Location for Enrollment - External Reference setup via Application |
| Field: | LoyaltyProgramId (Integer) Required - The Loyalty Program Id to check (Hardcoded value for the specific Loyalty Program) |
| Field: | CouponPromotionId (Integer) Required - The Coupon Promotion Id to redeem - Comes from call 'ReturnCouponOffers' |
| Field: | CouponTypeId (Integer) Required - The Coupon Type Id to redeem - Comes from call 'ReturnCouponOffers' |
| Type: | respRedeemCouponOffer |
| Field: | ReturnCode (Integer) - (0) - Success / (Non-Zero) - Error (See Below) |
| Field: | MemberCouponId (Integer) - Unique Internal Id of the Coupon Issued |
| Field: | MemberCouponName (String) - Coupon Name as entered with Coupon Slip |
| Field: | MemberCouponDescription (String) - Coupon Description as entered with Coupon Slip |
| Field: | MemberCouponDisclaimer (String) - Coupon Disclaimer as entered with Coupon Slip |
| Field: | MemberCouponIssueTimestamp (String) Issue Timestamp in Format mm/dd/yyyy hh:mm:ss |
| Field: | MemberCouponBarcode (String) Barcode assigned to Coupon (be the same as MemberCouponId or a Fixed Barcode) |
| Additional Information | |
| Notes: | |
| Error Codes | |
| Possible Return Codes: |
(0) - Sucess (1) - Undefined Error (Please Contact Support) (2) - Required Field Missing (100) - Invalid Security Token (101) - Invalid Permission for Method (300) - Invalid Account Id (302) - Account is Suspended (312) - Member Is Prospect - Call Not Allowed For Prospects (1002) - Invalid Location External Reference (1500) - Unable to Redeem Coupon Offer |
| Reference | |
| click for: | Web Services Overview |
| link: | Web Services Map |
| link: | SBLP Security Token Information |
|
Copyright © 2003-2021 Kognitiv, Corp. All rights reserved. |