Get Products by Category

Request Details

Method Controller Resource Parameters
GET product category  cat_id

Parameters Guide

Parameter Accepts
cat_id int Internal category id in Beep Database

Example Request Format

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

Sample Response

Success
{  
   "success":true,
   "request":{  
      "method":"GET",
      "controller":"product",
      "resource":"category",
      "parameters":{  
         "\/product\/category\/92":""
      },
      "url_elements":[  
         "product",
         "category",
         "92"
      ]
   },
   "error":{  
      "errorid":0,
      "message":0
   },
   "data":{  
      "id":"1074",
      "barcode":"",
      "prod_name":"product+2",
      "prod_alias":"product2",
      "prod_description":"",
      "prod_image":"images",
      "catid":"92",
      "cat_name":"Comics",
      "cat_alias":"Comics",
      "cat_desc":"Comics"
   }
}
Error
{  
   "success":false,
   "request":{  
      "method":"GET",
      "controller":"product",
      "resource":"category",
      "parameters":{  
         "\/product\/category\/1":""
      },
      "url_elements":[  
         "product",
         "category",
         "1"
      ]
   },
   "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)
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