Request Details
Method
|
Controller
|
Resource
|
Parameters
|
GET |
product |
details |
product_id |
Parameters Guide
Parameter
|
Accepts
|
product_id |
int id of product in Beep Database |
Example Request Format
Direct Url
|
https://api.beepxtra.com/product/details/12 |
Curl
|
[code]CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|product" -X GET https://api.beepxtra.com/product/details/12 |
PHP SDK
|
$beepapi->request('get', 'product', 'details/12'); |
Sample Response
Success
{
"success":true,
"request":{
"method":"GET",
"controller":"product",
"resource":"details",
"parameters":{
"\/product\/details\/12":""
},
"url_elements":[
"product",
"details",
"12"
]
},
"error":{
"errorid":0,
"message":0
},
"data":{
"id":"12",
"barcode":"7940056600",
"prod_name":"Dove Go Fresh 74G",
"prod_alias":"dove-go-fresh-74g",
"prod_description":"Anti-perspirant Stick Deodorant. Cucumber and green tea essentials.",
"prod_image":"images",
"catid":"2669",
"cat_name":"Unisex Fragrances",
"cat_alias":"Unisex-Fragrances",
"cat_desc":"Unisex Fragrances"
}
}
Error
{
"success":false,
"request":{
"method":"GET",
"controller":"product",
"resource":"details",
"parameters":{
"\/product\/details\/1000000":""
},
"url_elements":[
"product",
"details",
"1000000"
]
},
"error":{
"errorid":1000,
"message":"Product cannot be found. Please check your request"
},
"data":{
"error":"Product cannot be found. Please check your request"
}
}
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) |