Follow

Redeem Offer

Checks a 'Unique text' type code for the given organization AND flags the code as having been used. Any subsequent requests to the same code + organization will fail.

 

Attributes 

Attribute

Value

Path

/v3/redeemedOffers

Support Formats

JSON, XML

HTTP Method

POST

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        400 - Bad Request

·        401 - Unauthorized 

 

Request

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

Type

Value

Header

POST /v3/redeemedOffers HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Body

{

    "organisationId":648,

    "redemptionText":"XYZ-E6W5F",

    "venueId":921,

    "externalVenueId":null,

    "externalVenueSystemType":null

}

OR

{

    "organisationId":648,

    "redemptionText":"XYZ-E6W5F",

    "venueId":null,

    "externalVenueId":"ExternalIdName",

    "externalVenueSystemType":10

}

Notes:

  1. The venueId or externalVenueId and externalVenueSystemType must be provided.

 

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":921,

      "externalVenueId":null,

      "externalVenueSystemType":null

   }

]

 

Unsuccessful Response

The following table contains the details of a typical unsuccessful 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":false,

      "redemptionText":"XYZ875"  

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

      "offerDescription":"20% off Muffins",

      "reason":"Already Redeemed 24 September 2012 by Joe Bloggs at South Central Plaza",

      "venueId":921,

      "externalVenueId":null,

      "externalVenueSystemType":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.