Request Details
Method
|
Controller
|
Resource
|
Parameters
|
DELETE |
product |
outlet |
outlet_id / product / product_id |
Parameters Guide
Parameter
|
Accepts
|
outlet_id |
int outlet id as provided by BeepXtra |
product |
string default value to "product" |
product_id |
int The existing product id you wish to remove from this outlet |
Example Request Format
Direct Url
|
https://api.beepxtra.com/product/outlet/391/product/3 |
Curl
|
CURL -A "YOURAPPNAME|1.0|AppID|AppKEY|product" -X DELETE https://api.beepxtra.com/product/outlet/391/product/3 |
PHP SDK
|
$beepapi->request('delete', 'product', 'outlet/391/product/123'); |
Sample Response
Success
{
"success":true,
"request":{
"method":"DELETE",
"controller":"product",
"resource":"outlet",
"parameters":"\/product\/outlet\/391\/product\/1274",
"url_elements":[
"product",
"outlet",
"391",
"product",
"1274"
]
},
"error":{
"errorid":0,
"message":0
},
"data":{
"success":"true"
}
}
Error
{
"success":false,
"request":{
"method":"DELETE",
"controller":"product",
"resource":"outlet",
"parameters":"\/product\/outlet\/391\/product\/1274",
"url_elements":[
"product",
"outlet",
"391",
"product",
"1274"
]
},
"error":{
"message":"Product is not used by this outlet",
"errorid":621
},
"data":{
"error":"Product is not used by this outlet",
"errorid":621,
"errormsg":"Product is not used by this outlet"
}
}
Response Guide
Parameter
|
Type
|
Details
|
error |
String |
Returns Error Object with errorid and errormsg |
success |
boolean |
Returns true if successful |