Delete SalesReturn

Deletes the details of a SalesReturn object that has been previously created.

Parameters

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/SalesReturn will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/SalesReturn

Query Params
filter	string In this parameter fieldname needs to be provided with condition and value to delete related details.for eg. OrderSubject,eq,Salesreturn subject 1) To delete SalesReturn with status is equal to shipped and custom field(Test CheckBox) value is no or off, the follwing url must be used https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=OrdersStatus,eq,Created \| Invoiced \| Shipped;Test CheckBox,eq,no&key=xyzkey 2) To delete SalesReturn with created date between 01-15-2020 to 01-31-2020 (Use \| between two dates), the follwing url must be used https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=OrderCreatedDate,bt,01-15-2020 \| 01-31-2020&key=xyzkey List of condition abbrevations to be used: "cs": contain string (string contains value) "sw": start with (string starts with value) "ew": end with (string end with value) "neq": not equal (string or number should not match) "eq": equal (string or number matches exactly) "lt": lower than (number is lower than value) "le": lower or equal (number is lower than or equal to value) "ge": greater or equal (number is higher than or equal to value) "gt": greater than (number is higher than value) "bt": between (number is between two comma separated values)

Query Params

filter

string
In this parameter fieldname needs to be provided with condition and value
to delete related details.for eg. OrderSubject,eq,Salesreturn subject

1) To delete SalesReturn with status is equal to shipped and custom field(Test CheckBox) value is no or off, the follwing url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=OrdersStatus,eq,Created | Invoiced | Shipped;Test CheckBox,eq,no&key=xyzkey

2) To delete SalesReturn with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the follwing url must be used

https://xyzcompany.agiliron.net/agiliron/api-40/SalesReturn?filter=OrderCreatedDate,bt,01-15-2020 | 01-31-2020&key=xyzkey

List of condition abbrevations to be used:
"cs": contain string (string contains value)
"sw": start with (string starts with value)
"ew": end with (string end with value)
"neq": not equal (string or number should not match)
"eq": equal (string or number matches exactly)
"lt": lower than (number is lower than value)
"le": lower or equal (number is lower than or equal to value)
"ge": greater or equal (number is higher than or equal to value)
"gt": greater than (number is higher than value)
"bt": between (number is between two comma separated values)

Header Params
Accept:	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.

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.

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="SalesReturn">
       <method name="DELETE">
         <resource path="{filter}">
         <request>
           <param name="key" type="xsd:string" style="query" 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>

Updated over 1 year ago