Follow

Get Redeemed Offers by Date Range and Username

Returns the redeemed offers by date range, username and including the deleted offers or not

 

Attributes 

Attribute

Value

Path

/v3/RedeemedOffers/consumerRedeemedOffers

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request. 

·        500 - Internal Server Error. 

 

Request

The following table contains the details of a typical HTTP request for this service:

Type

Value

Header

GET /v3/RedeemedOffers/consumerRedeemedOffers HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Param 

?redeemedAfter=(datetime)
&redeemedBefore=(datetime)
&partialUsername=(string)
&includeDeleted=(bool)

 

Successful Response

The following table contains the details of a typical successful HTTP request for this service. 

Type

Value

Header

HTTP/1.1 200 OK

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

{    "id": 105428,

     "title": "BIRTHDAY!!",    

     "description": "Description",

     "offerId": 5600,

     "startDate": "2014-03-31T22:00:00Z",

     "endDate": "2014-05-20T22:00:00Z",

     "termsAndConditions": "Terms",

     "redemptionText": "XYZ-QAN4S",

     "redemptionImage": null,

     "merchantId": 683,

     "venueIds": null,

     "codeType": 1,

     "lastUpdatedAt": "0001-01-01T00:00:00Z",

     "paymentProviderSuccessUrl": null,

     "isAGift": false,

     "giftId": null,

     "giftBatchId": null,

     "giftedOnDate": null,

     "giftedByConsumerId": null,

     "offerInstanceUniqueId": "105428",

     "burnt": false,

     "isReward": false,

     "isDeleted": true,

     "whenRedeemed": "2014-04-30T16:04:48.1001973+12:00"  }

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.