Welcome‎ > ‎Version 3‎ > ‎Publisher Api‎ > ‎Methods‎ > ‎2 - Consumer Related‎ > ‎

Consumer Redeem Voucher

Marks a voucher as redeemed or unredeemed by the consumer of that voucher for UI purposes.  This is not the same as the voucher being officially redeemed by the merchant.

Method: PUT /api/v3/publisher/consumer/{userKey}/redeemvoucher

Authentication: oauth

Parameters
userKey - the user key of the consumer marking a voucher as redeemed.

Put
Required Form Name Data Type Explanation
Yes
ConsumerMarkedRedeemed bool Whether to mark the voucher as redeemed or unredeemed by the consumer.
Yes
OfferOptionId
int The offer option id of the offer option that the voucher is for.
Yes
VoucherCode string The voucher code of the voucher.

Returns
base response fields - if success is true, the voucher was successfully marked as redeemed or unredeemed.


Sample Request:

PUT http://api.groupcommerce.com/api/v3/publisher/consumer/3c651ac9e6054d72b9b938f782790c8c/redeemvoucher

Form: ConsumerMarkedRedeemed=True&OfferOptionId=6126&VoucherCode=P-3221-16-08004

Authorization: OAuth oauth_signature="YCXP5ajbXcBrPQWvj2g9zpwOs5I%3d", oauth_nonce="6536944", oauth_timestamp="1328290828", oauth_consumer_key="eeb6b959-b854-4ad1-b563-e801c83cf81d", oauth_signature_method="HMAC-SHA1", oauth_version="1.0"


Sample JSON Response:

{
    "errors": [],
    "lastPublished": "/Date(1328290828219)/",
    "success": true,
    "version": "3"
}


Sample XML Response:

<consumerRedeemVoucherResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <errors />
  <lastPublished>2012-02-03T17:41:49.0014186Z</lastPublished>
  <success>true</success>
  <version>3</version>
</consumerRedeemVoucherResponse>
Comments