Smart Button Loyalty Platform - WS
Smart Button Inc.
1501 Casho Mill Road, Suite 14
Newark DE 19711

PointOfSale


Click here for a complete list of operations.

RedeemCouponOffer

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /WS/PointOfSale.asmx HTTP/1.1
Host: app.smartbutton.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "LoyaltyPlatformWS/RedeemCouponOffer"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemCouponOffer xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <LocationExternalRef>string</LocationExternalRef>
      <LoyaltyProgramId>int</LoyaltyProgramId>
      <CouponPromotionId>int</CouponPromotionId>
      <CouponTypeId>int</CouponTypeId>
    </RedeemCouponOffer>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RedeemCouponOfferResponse xmlns="LoyaltyPlatformWS">
      <RedeemCouponOfferResult>
        <ReturnCode>int</ReturnCode>
        <MemberCouponId>int</MemberCouponId>
        <MemberCouponName>string</MemberCouponName>
        <MemberCouponDescription>string</MemberCouponDescription>
        <MemberCouponDisclaimer>string</MemberCouponDisclaimer>
        <MemberCouponIssueTimestamp>string</MemberCouponIssueTimestamp>
        <MemberCouponBarcode>string</MemberCouponBarcode>
      </RedeemCouponOfferResult>
    </RedeemCouponOfferResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /WS/PointOfSale.asmx HTTP/1.1
Host: app.smartbutton.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RedeemCouponOffer xmlns="LoyaltyPlatformWS">
      <WSSecurityToken>string</WSSecurityToken>
      <MemberAccountId>string</MemberAccountId>
      <SBInternalMemberId>int</SBInternalMemberId>
      <LocationExternalRef>string</LocationExternalRef>
      <LoyaltyProgramId>int</LoyaltyProgramId>
      <CouponPromotionId>int</CouponPromotionId>
      <CouponTypeId>int</CouponTypeId>
    </RedeemCouponOffer>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RedeemCouponOfferResponse xmlns="LoyaltyPlatformWS">
      <RedeemCouponOfferResult>
        <ReturnCode>int</ReturnCode>
        <MemberCouponId>int</MemberCouponId>
        <MemberCouponName>string</MemberCouponName>
        <MemberCouponDescription>string</MemberCouponDescription>
        <MemberCouponDisclaimer>string</MemberCouponDisclaimer>
        <MemberCouponIssueTimestamp>string</MemberCouponIssueTimestamp>
        <MemberCouponBarcode>string</MemberCouponBarcode>
      </RedeemCouponOfferResult>
    </RedeemCouponOfferResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /WS/PointOfSale.asmx/RedeemCouponOffer?WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&LocationExternalRef=string&LoyaltyProgramId=string&CouponPromotionId=string&CouponTypeId=string HTTP/1.1
Host: app.smartbutton.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<RedeemCouponOfferReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <MemberCouponId>int</MemberCouponId>
  <MemberCouponName>string</MemberCouponName>
  <MemberCouponDescription>string</MemberCouponDescription>
  <MemberCouponDisclaimer>string</MemberCouponDisclaimer>
  <MemberCouponIssueTimestamp>string</MemberCouponIssueTimestamp>
  <MemberCouponBarcode>string</MemberCouponBarcode>
</RedeemCouponOfferReturn>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /WS/PointOfSale.asmx/RedeemCouponOffer HTTP/1.1
Host: app.smartbutton.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

WSSecurityToken=string&MemberAccountId=string&SBInternalMemberId=string&LocationExternalRef=string&LoyaltyProgramId=string&CouponPromotionId=string&CouponTypeId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<RedeemCouponOfferReturn xmlns="LoyaltyPlatformWS">
  <ReturnCode>int</ReturnCode>
  <MemberCouponId>int</MemberCouponId>
  <MemberCouponName>string</MemberCouponName>
  <MemberCouponDescription>string</MemberCouponDescription>
  <MemberCouponDisclaimer>string</MemberCouponDisclaimer>
  <MemberCouponIssueTimestamp>string</MemberCouponIssueTimestamp>
  <MemberCouponBarcode>string</MemberCouponBarcode>
</RedeemCouponOfferReturn>