Delete Bulk Products
Deletes the details of a Products object that has been previously created.
Parameters
Body Params | |
---|---|
body: | string Products details needs to be passed as body parameter,it should be in either XML format or JSON format. |
Path Params | |
---|---|
yourCompany: | string The Company name need to passed in the base URL.For eg. if you enter xyzcompany name, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Bulk-Products will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/Bulk-Products |
callback_url | string The callback URL need to passed in the base URL , which means after the code execution this file gets called.For eg. https://abc.php, the url https://{yourCompany}.agiliron.net/agiliron/api-40.php/Bulk-Products?callback_url=https://abc.php&key=xyzkey In this case after execution of code the curl call will made on https://abc.php. |
sendRecordNo | string The value as true or false need to passed for this parameter in the base URL.For eg. if you want record number with response then send value as true ,For eg. https://xyzcompany.agiliron.net/agiliron/api-40.php/Bulk-Products&key=xyzkey&sendRecordNo=true. By default it will be false. |
Header Params | |
---|---|
Accept: | string Response header need to be passed for eg. application/json or application/xml. |
Query Auth | |
---|---|
key: | string API key needs to be passed in this variable.The option to enter API key will appear when you click on Try it button.This will be the first option in AUTHENTICATION block.Default is SET to 0. |
Header Auth | |
---|---|
apiKey: | string Dedicated API key needs to be passed in this variable via header.The option to enter API key will appear when you click on Try it button.This will be the second option in AUTHENTICATION block.Default is SET to 0. |
Sample Code
{
"Products": {
"Product": [
{
"ProductCode": "TNP1"
},
{
"ProductCode": "TNP2"
}
]
}
}
<Products>
<Product>
<ProductCode>TNP1</ProductCode>
</Product>
<Product>
<ProductCode>TNP2</ProductCode>
</Product>
</Products>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Bulk-Products">
<method name="DELETE">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="ProductCode" type="xsd:string" style="body" required="true"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Sample Webhook
<?php
$url = "https://{your_custom_url}"; //this custom url will be called after the code is executed
$curlConn = curl_init();
curl_setopt($curlConn, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curlConn, CURLOPT_POSTFIELDS,$results); //$results contain the result set
curl_setopt($curlConn,CURLOPT_URL,$url);
curl_setopt($curlConn, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($curlConn, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($curlConn, CURLOPT_RETURNTRANSFER, 1);
$ret = curl_exec($curlConn);
?>
<result>
<SuccessNumber>1</SuccessNumber>
<FailureNumber>1</FailureNumber>
<Success>
<Product>
<ProductCode>TNP1234</ProductCode>
</Product>
</Success>
<Failure>
<Product>
<ProductCode>TNP123</ProductCode>
<Message>Invalid Product code</Message>
</Product>
</Failure>
</result>
{
"result": {
"SuccessNumber": "1",
"FailureNumber": "1",
"Success": {
"Product": {
"ProductCode": "TNP1234"
}
},
"Failure": {
"Product": {
"ProductCode": "TNP123",
"Message": "Invalid Product code"
}
}
}
}
<result>
<SuccessNumber>1</SuccessNumber>
<FailureNumber>1</FailureNumber>
<Success>
<Product>
<ProductCode>TNP1234</ProductCode>
<Record>1</Record>
</Product>
</Success>
<Failure>
<Product>
<ProductCode>TNP123</ProductCode>
<Message>Invalid vendor name</Message>
<Record>2</Record>
</Product>
</Failure>
</result>
{
"result": {
"SuccessNumber": "1",
"FailureNumber": "1",
"Success": {
"Product": {
"ProductCode": "TNP1234",
"Record": "1"
}
},
"Failure": {
"Product": {
"ProductCode": "TNP123",
"Message": "Invalid vendor name",
"Record": "2"
}
}
}
}
Updated over 1 year ago