Update PriceBook
Use this operation to update any of the writable fields of an existing PriceBook object. The request body must include all writable fields of the existing object as returned in a read response. Writable fields omitted from the request body are set to NULL.
Parameters
Body Params | |
---|---|
JSON: | json |
XML: | string |
Path Params | |
---|---|
yourCompany: | string |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Pricebooks": {
"PriceBook": {
"PriceBookId": "142993",
"PriceBookName": "Default PriceBook",
"Active": "Yes",
"IsSpecialPriceBook": "No",
"IsVendorPriceBook": "No",
"IsVolumePriceBook": "No",
"SpecialsStartDate": "00-00-0000",
"SpecialsEndDate": "00-00-0000",
"DefaultCurrency": "US Dollar",
"Description": "Description Goes Here.",
"CreatedTime": "03-18-2025 11:44:57",
"CreatedTimeUTC": "03-18-2025 06:14:57",
"ModifiedTime": "03-18-2025 11:45:10",
"ModifiedTimeUTC": "03-18-2025 06:15:10"
},
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<Pricebooks>
<PriceBook>
<PriceBookId>142993</PriceBookId>
<PriceBookName>Default PriceBook</PriceBookName>
<Active>Yes</Active>
<IsSpecialPriceBook>No</IsSpecialPriceBook>
<IsVendorPriceBook>No</IsVendorPriceBook>
<IsVolumePriceBook>No</IsVolumePriceBook>
<SpecialsStartDate>00-00-0000</SpecialsStartDate>
<SpecialsEndDate>00-00-0000</SpecialsEndDate>
<DefaultCurrency>US Dollar</DefaultCurrency>
<Description>Description Goes Here.</Description>
<CreatedTime>03-18-2025 11:44:57</CreatedTime>
<CreatedTimeUTC>03-18-2025 06:14:57</CreatedTimeUTC>
<ModifiedTime>03-18-2025 11:45:10</ModifiedTime>
<ModifiedTimeUTC>03-18-2025 06:15:10</ModifiedTimeUTC>
</PriceBook>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</Pricebooks>
Sample Response
{
"MCM": {
"response": {
"objectType": "PriceBook",
"syncTime": "2025-03-28 07:43:53"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"pricebook_name": "Default PriceBook",
"pricebook_id": "143231"
}
}
}
}
}
}
<MCM>
<response>
<objectType>PriceBook</objectType>
<syncTime>2025-03-28 07:43:53</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<pricebook_name>Default PriceBook</pricebook_name>
<pricebook_id>143231</pricebook_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="PriceBook">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
<param name="PriceBookName" type="xsd:string" style="body" required="true"/>
<param name="Active" type="xsd:string" style="body"/>
<param name="IsSpecialPriceBook" type="xsd:string" style="body"/>
<param name="IsVendorPriceBook" type="xsd:string" style="body"/>
<param name="IsVolumePriceBook" type="xsd:string" style="body"/>
<param name="SpecialsStartDate" type="xsd:date" style="body"/>
<param name="SpecialsEndDate" type="xsd:date" style="body"/>
<param name="DefaultCurrency" type="xsd:string" style="body"/>
<param name="Description" type="xsd:string" style="body"/>
<param name="CreatedTime" type="xsd:dateTime" style="body"/>
<param name="ModifiedTime" type="xsd:dateTime" style="body"/>
</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 about 22 hours ago