Follow

List All Offers

Returns a list of all offers.

 

Attributes 

Attribute

Value

Path

/v3/offers

Support Formats

JSON, XML

HTTP Method

GET

Secure

Yes

Rate Limited

No

Cache Timeout

TBC

HTTP Codes

·        200 - OK

·        500 - Internal Server Error. 

 

Request

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

Type

Value

Header

GET /v3/offers HTTP/1.1

Host: merchant.api.vmob.co

Content-Type: application/json

Accept-Language: en-US

x-vmob-authorization: dm1vYi53aW5kb3dzLjE6

Query
Params

?offerStatus=(int)
&activeDate=(datetime)
&lastModifiedBefore=(datetime) 
&lastModifiedAfter=(datetime)

Notes:

  • By default all offers are returned, offerStatus filter can used to filter out by status - valid values are:

         Draft = 0
         Published = 1
         Archived = 2

 

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

[
  {
    "noCompeteGroup": null,
    "redemptionText": null,
    "status": 1,
    "redemptionCount": 6,
    "burnCount": 0,
    "categoryId": 1,
    "categoryName": "Default",
    "codeType": 2,
    "contentTagReferenceCodes": [],
    "contentUrl": "",
    "dailyEndTime": null,
    "dailyStartTime": null,
    "daysOfWeek": [0,1,2,3,4,5,6],
    "description": "test",
    "endDate": "2016-12-01T01:00:00Z",
    "extendedData": null,
    "id": 1,
    "image": null,
    "imageDescription": null,
    "imageAlt": null,
    "imageAltDescription": null,
    "isAvailableAllStores": false,
    "isGiftable": false,
    "isPremiumPlacement": false,
    "isRespawningOffer": false,
    "isReward": false,
    "lastUpdatedAt": "2015-12-21T22:22:22Z",
    "merchantId": 563,
    "paymentAmount": null,
    "paymentTaxRate": 0.0,
    "paymentType": 0,
    "respawnsInDays": null,
    "sortOrder": 0,
    "startDate": "2015-11-01T01:00:00Z",
    "termsAndConditions": "test",
    "title": "New Offer test",
    "venueExternalIds": [],
    "venueIds": null,
    "weighting": 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.