Get Outlet Products

Request Details

Method Controller Resource Parameters
GET product outlet  outlet_id

Parameters Guide

Parameter Accepts
outlet_id int id of outlet in Beep Database

Example Request Format

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

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"GET",
      "controller":"product",
      "resource":"outlet",
      "parameters":{  
         "\/product\/outlet\/1":""
      },
      "url_elements":[  
         "product",
         "outlet",
         "1"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":{  
      "id":"1126",
      "barcode":"1",
      "prod_name":"dog",
      "prod_alias":"dog",
      "prod_description":"",
      "prod_image":"image",
      "outlet_price":"100.05",
      "outlet_discount":"2.5",
      "quantity":"10.00",
      "reorder_level":"2",
      "delivery_type":"pickup",
      "weight":"0.00",
      "shipping_cost":"1.00",
      "availability":"1",
      "promo_price":"0.00",
      "promo_start_date":null,
      "promo_end_date":null,
      "outlet_prod_name":"dog",
      "outlet_prod_alias":"dog",
      "outlet_prod_desc":"dog",
      "outlet_prod_image":"image",
      "catid":"3470",
      "cat_name":"Dog Chews & Treats",
      "cat_alias":"Dog-Chews-Treats",
      "cat_desc":"Dog Chews & Treats"
   }
}
Error
{  
   "success":false,
   "request":{  
      "method":"GET",
      "controller":"product",
      "resource":"outlet",
      "parameters":{  
         "\/product\/outlet\/10":""
      },
      "url_elements":[  
         "product",
         "outlet",
         "10"
      ]
   },
   "error":{  
      "errorid":1000,
      "message":"No products found."
   },
   "data":{  
      "error":"No products found."
   }
}

Response Guide

Parameter Type Details
error String Returns Error Object with errorid and errormsg
id int The internal id of the product in Beep Database
barcode string The listed barcode in beep database (Notice: No verification against international standards - user submitted)
prod_name string Product name
prod_alias string The alias used for SEF URLs
prod_desctiption string The description of the product
prod_image string The product image path if available (defaults to "images" if N/A)
outlet_price double The price of the product as listed by the current outlet
outlet_discount double The Beep discount % of the product as listed by the current outlet
quantity int The current quantity in stock as listed by the current outlet
reorder_level int The minimum stock quantity before the outlet is notified to reorder
delivery_type string The default delivery type offered by the outlet (Defaults to "pickup")
promo_start_date date The starting date if a special promo price has been applied
promo_end_date date The ending date if a special promo price has been applied
outlet_prod_name string Product name override if specified by outlet
outlet_prod_alias string The alias override if specified by outlet
outlet_prod_desctiption string The description override if specified by outlet
outlet_prod_image string The product image path override if specified by outlet
catid int The internal category id where the product is listed (See categories)
cat_name string Category name
cat_alias string The category alias for SEF URLs
cat_desc string The category description if available (Defaults to cat_name)

Search

API Documentation