Delete PriceBook

Deletes the details of a PriceBook 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/PriceBook will change to https://xyzcompany.agiliron.net/agiliron/api-40.php/PriceBook

Query Params
filter:	string In this parameter fieldname needs to be provided with condition and value to delete related details.for eg. PriceBookName,eq,Default PriceBook 1. To delete PriceBook with PriceBookName equal to New PriceBook and custom field(Test CheckBox) value is no or off, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookName,eq,New PriceBook;Test CheckBox,eq,no&key=xyzkey 2. To delete PriceBook with created date between 01-15-2020 to 01-31-2020 (Use \| between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=CreatedTime,bt,01-15-2020 \| 01-31-2020&key=xyzkey 3. To delete PriceBook with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use \| between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=CreatedTime,bt,01-15-2020 01:03:10\| 01-31-2020 20:00:00&key=xyzkey 4. To delete PriceBook with PriceBookId equal to 3422, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookId,eq,3422&key=xyzkeyList 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. PriceBookName,eq,Default PriceBook

1. To delete PriceBook with PriceBookName equal to New PriceBook and custom field(Test CheckBox) value is no or off, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookName,eq,New PriceBook;Test CheckBox,eq,no&key=xyzkey

2. To delete PriceBook with created date between 01-15-2020 to 01-31-2020 (Use | between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey

3. To delete PriceBook with created datetime between 01-15-2020 01:03:10 to 01-31-2020 20:00:00 (Use | between two dates), the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey

4. To delete PriceBook with PriceBookId equal to 3422, the following url must be usedhttps://xyzcompany.agiliron.net/agiliron/api-40/PriceBook?filter=PriceBookId,eq,3422&key=xyzkeyList 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 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.

WADL

<?xml version="1.0" encoding="utf-8"?>
<application>
   <resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
     <resource path="PriceBook"> 
       <method name="DELETE">
	   <resource path="{PriceBookId/PriceBookName}">
         <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 4 days ago