Get Special Offers

Request Details

Method Controller Resource Parameters
GET platform specialoffers country_id

Parameters Guide

Parameter Accepts
country_id int (OPTIONAL) Internal Country id in Beep Database

Example Request Format

Direct Url https://api.beepxtra.com/platform/specialoffers/1
Curl [code]CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|platform" -X GET https://api.beepxtra.com/platform/specialoffers/1
PHP SDK $beepapi->request('get', 'platform', 'specialoffers/1');

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"GET",
      "controller":"platform",
      "resource":"specialoffers",
      "parameters":"\/platform\/specialoffers\/1",
      "url_elements":[  
         "platform",
         "specialoffers",
         "1"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":[  
      {  
         "id":"11",
         "outlet_id":"391",
         "title":"Software",
         "logo":"offer_logo_2_1416996170.jpeg",
         "logo_path":"https://www.beepstores.com/img/uploads/offers/offer_logo_2_1416996170.jpeg"
         "description":"A Proven Payment Solution\nNow Optimized\nFor Software Vendors",
         "price":"150.00",
         "beep_discount":"3.00",
         "start_date":"2014-12-02 12:00:00",
         "end_date":"2016-05-04 11:59:59",
         "duration":"1",
         "added_on":"2014-11-24 11:30:42",
         "fixed_price":"1",
         "active":"1",
         "deleted":"0",
         "currency":"EUR",
         "outletid":"391",
         "outlet_name":"Exevior",
         "outlet_alias":"exevior",
         "storeid":"1415",
         "store_name":"Exevior Technologies Ltd",
         "store_alias":"exevior-technologies-ltd",
         "country_name":"Cyprus",
         "country_alias":"Cyprus",
         "fixed":"1"
      },
      {  
         "id":"271",
         "outlet_id":"548",
         "title":"\u05e9\u05e0\u05d9 \u05d1\u05d2\u05d8\u05d9\u05dd \u05e9\u05e0\u05d9\u05e6\u05dc\u05d9\u05dd   \u05e9\u05ea\u05d9\u05d9\u05d4 \u05d2\u05d3\u05d5\u05dc \u05d1\u05de\u05d1\u05e6\u05e2",
         "logo":"offer_logo_3109_1426682370.jpeg",
         "logo_path":"https://www.beepstores.com/img/uploads/offers/offer_logo_3109_1426682370.jpeg"
         "description":"\u05d1\u05de\u05d1\u05e6\u05e2 \u05dc\u05e9\u05d1\u05d5\u05e2 \u05d9\u05de\u05d9\u05dd\n\u05ea\u05e7\u05d1\u05dc\u05d5 \u05e9\u05e0\u05d9 \u05d1\u05d2\u05d8\u05d9\u05dd \u05e2\u05dd \u05e9\u05e0\u05d9\u05e6\u05dc\u05d9\u05dd   \u05d1\u05e7\u05d1\u05d5\u05e7 \u05de\u05d9\u05e5 \u05d2\u05d3\u05d5\u05dc\n\u05db\u05dc \u05d6\u05d4 \u05e8\u05e7 69 \u05e9\"\u05d7.\n\u05d7\u05d1\u05e8\u05d9 \u05de\u05d5\u05e2\u05d3\u05d5\u05df \u05d1\u05d9\u05d0\u05e7\u05e1\u05d8\u05e8\u05d0   5% \u05d4\u05e0\u05d7\u05d4",
         "price":"59.00",
         "beep_discount":"5.00",
         "start_date":"2015-03-18 12:00:00",
         "end_date":"2016-05-04 11:59:59",
         "duration":"4",
         "added_on":"2015-03-18 14:39:38",
         "fixed_price":"1",
         "active":"1",
         "deleted":"0",
         "currency":"EUR",
         "outletid":"548",
         "outlet_name":"Exevior Serial Killing Business",
         "outlet_alias":"exevior-serial-killing-business",
         "storeid":"1415",
         "store_name":"Exevior Technologies Ltd",
         "store_alias":"exevior-technologies-ltd",
         "country_name":"Cyprus",
         "country_alias":"Cyprus",
         "fixed":"1"
      }
   ]
}
Error
{  
   "success":false,
   "request":{  
      "method":"GET",
      "controller":"platform",
      "resource":"specialoffers",
      "parameters":"\/platform\/specialoffers\/cy",
      "url_elements":[  
         "platform",
         "specialoffers",
         "cy"
      ]
   },
   "error":{  
      "message":"Invalid Country specified. Should be numeric",
      "errorid":420
   },
   "data":{  
      "error":"Invalid Country specified. Should be numeric",
      "errorid":420,
      "errormsg":"Invalid Country specified. Should be numeric"
   }
}

Response Guide

Parameter Type Details
error String Returns Error Object with errorid and errormsg
id int The internal id of the offer in Beep Database
outlet_id int The internal outlet id in Beep Database
title string Title of offer
logo string The offer image path if available (defaults to null if N/A)
logo_path string The offer image full path if available (defaults to null if N/A)
desctiption string The description of the offer
price decimal(15,2) The price amount of the offer
beep_discount decimal(15,2) The discount offered
start_date date Date the offer is starting
end_date date Date the offer is finishing
duration int The number of weeks this offer is available
added_on date Date this offer was added to the system
fixed_price int If 1 the beep_discount is a fixed price. If 0 the beep_discount is a percentage(%)
active int Returns 1 if the offer is currently active, 0 if expired or not yet active
deleted int Returns 1 if the offer has been marked deleted
currency string The currency of the offer (ie. EUR, GBP, USD etc)
outletid int The internal outlet id in Beep Database
outlet_name string name of the outlet
outlet_alias string Alias of the outlet name used for SEF URLs
storeid int The internal store id in Beep Database that this outlet belongs to
store_name string name of the store
store_alias string Alias of the store name used for SEF URLs
country_name string Country name of the outlet
country_alias string Alias of the country name used for SEF URLs

Search

API Documentation