Follow

Check Redeemed Offer

Checks a 'Unique text' type code for the given organization (but does not 'Use' the code). If the code has already been redeemed then an appropriate response code will be returned.

 

Attributes 

Attribute

Value

Path

/v3/redeemedOffers

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        401 - Unauthorized

·        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 HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Params

?organisationId=(int)
&redemptionText=(string) 

 Notes:

  1. The redemptionText must be a valid code for that Merchant.
  2. Check Redeemed Offers returns the details of a redeemed offer regardless of whether it has been 'deleted' or not.

 

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

[

   {

      "organisationId":0,

      "offerId":"286",

      "isValid":true,

      "redemptionText":"XYZ-E6W5F",  

      "expiryDate":"2013-12-24",

      "offerDescription":"20% off Muffins",

      "reason":"",

      "venueId": null,

      "externalVenueId":null,

      "externalVenueSystemType":null,

      "verificationToken": "5001",

      "extendedData":{

                       "some_other_info" : "customer defined data",

                   "vm_dob" : "2015-04-30 05:32:30 +0000"

             }

   }

]

 

Unsuccessful Response

The following table contains the details of a typical unsuccessful HTTP Request for this service. 

Type

Value

Header

HTTP/1.1 400 Bad Request

Content-Type: application/json

Cache-Control: no-store

Pragma: no-cache

Body

{"error":"Invalid Code","errorDescription":null,"innerException":null}

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.