Update Quote
Use this operation to update any of the writable fields of an existing Quote 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
{
"Quotes": {
"Quote": [{
"QuoteId": "200530",
"QuoteNo": "120",
"ChannelId": "123",
"ChannelName": "Amazon",
"OrderDate": "2020-12-10 03:12:44",
"ModifiedDate": "2020-12-10 04:11:58",
"Subject": "Test New Quote",
"PotentialName": "New Potential",
"QuoteStage": "Created",
"ValidTill": "01-24-2020",
"CustomerNo": "",
"RelatedSO": "0",
"AccountId": "9505",
"AccountName": "Doe Inc.",
"AccountPhone": "23242342",
"AccountEmailAddress": "[email protected]",
"ContactId": "1490",
"ContactFirstName": "John",
"ContactLastName": "Doe",
"ContactPhone": "3324324",
"ContactEmailAddress": "[email protected]",
"Team": "Team A",
"BillingName": "John Doe",
"BillingStreet": "1234 Doe St., Ste 1234",
"BillingCity": "Oakland",
"BillingState": "CA",
"BillingZipCode": "94601",
"BillingCountry": "United States",
"ShipToName": "John Doe",
"ShipToPhone": "",
"ShipToEmailAddress": "",
"ShippingStreet": "4567 Doe Circle",
"ShippingCity": "San Francisco",
"ShippingState": "CA",
"ShippingZipCode": "94104",
"ShippingCountry": "United States",
"OrderDiscount": "5.50",
"SubTotal": "28.50",
"ShippingCost": "2.35",
"SalesTaxAuthority": "California State",
"SalesTaxes": "1.93",
"GrandTotal": "32.78",
"DefaultCurrency": "USD",
"ExchangeRate": "1",
"DefaultPriceBook": "Bargains",
"AssignedTo": "admin",
"TermsAndConditions": "Terms go here",
"Description": "Description goes here",
"Carrier": "UPS",
"ShippingMethod": "2nd Day Air",
"DeliverFrom": "OAK",
"QuoteCustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
},
"OrderDetails": {
"OD": [{
"ProductsName": "Test New Product1",
"ProductCode": "TNP1",
"ProductSKUCode": "",
"ProductNotes": "Product notes goes here.",
"ProductQty": "1",
"ProductPrice": "15",
"ProductDiscount": "0",
"ProductTotal": "30"
},
{
"ProductsName": "Test New Product2",
"ProductCode": "TNP2",
"ProductSKUCode": "",
"ProductNotes": "Product notes goes here.",
"ProductQty": "1",
"ProductPrice": "5",
"ProductDiscount": "0",
"ProductTotal": "10"
}
]
}
}]
}
}
<Quotes>
<Quote>
<QuoteId>200530</QuoteId>
<QuoteNo>120</QuoteNo>
<ChannelId>123</ChannelId>
<ChannelName>Amazon</ChannelName>
<OrderDate>2020-12-10 03:12:44</OrderDate>
<ModifiedDate>2020-12-10 04:11:58</ModifiedDate>
<Subject>Test New Quote</Subject>
<PotentialName>New Potential</PotentialName>
<QuoteStage>Created</QuoteStage>
<ValidTill>01-24-2020</ValidTill>
<CustomerNo></CustomerNo>
<RelatedSO>0</RelatedSO>
<AccountId>9505</AccountId>
<AccountName>Doe Inc.</AccountName>
<AccountPhone>23242342</AccountPhone>
<AccountEmailAddress>[email protected]</AccountEmailAddress>
<ContactId>1490</ContactId>
<ContactFirstName>John</ContactFirstName>
<ContactLastName>Doe</ContactLastName>
<ContactPhone>3324324</ContactPhone>
<ContactEmailAddress>[email protected]</ContactEmailAddress>
<Team>Team A</Team>
<BillingName>John Doe</BillingName>
<BillingStreet>1234 Doe St., Ste 1234</BillingStreet>
<BillingCity>Oakland</BillingCity>
<BillingState>CA</BillingState>
<BillingZipCode>94601</BillingZipCode>
<BillingCountry>United States</BillingCountry>
<ShipToName>John Doe</ShipToName>
<ShipToPhone></ShipToPhone>
<ShipToEmailAddress></ShipToEmailAddress>
<ShippingStreet>4567 Doe Circle</ShippingStreet>
<ShippingCity>San Francisco</ShippingCity>
<ShippingState>CA</ShippingState>
<ShippingZipCode>94104</ShippingZipCode>
<ShippingCountry>United States</ShippingCountry>
<OrderDiscount>5.50</OrderDiscount>
<SubTotal>28.50</SubTotal>
<ShippingCost>2.35</ShippingCost>
<SalesTaxAuthority>California State</SalesTaxAuthority>
<SalesTaxes>1.93</SalesTaxes>
<GrandTotal>32.78</GrandTotal>
<DefaultCurrency>USD</DefaultCurrency>
<ExchangeRate>1</ExchangeRate>
<DefaultPriceBook>Bargains</DefaultPriceBook>
<AssignedTo>admin</AssignedTo>
<TermsAndConditions>Terms go here</TermsAndConditions>
<Description>Description goes here</Description>
<Carrier>UPS</Carrier>
<ShippingMethod>2nd Day Air</ShippingMethod>
<DeliverFrom>OAK</DeliverFrom>
<QuoteCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</QuoteCustomFields>
<OrderDetails>
<OD>
<ProductsName>Test New Product1</ProductsName>
<ProductCode>TNP1</ProductCode>
<ProductSKUCode></ProductSKUCode>
<ProductNotes>Product notes goes here.</ProductNotes>
<ProductQty>1</ProductQty>
<ProductPrice>15</ProductPrice>
<ProductDiscount>0</ProductDiscount>
<ProductTotal>30</ProductTotal>
</OD>
<OD>
<ProductsName>Test New Product2</ProductsName>
<ProductCode>TNP2</ProductCode>
<ProductSKUCode></ProductSKUCode>
<ProductNotes>Product notes goes here.</ProductNotes>
<ProductQty>1</ProductQty>
<ProductPrice>5</ProductPrice>
<ProductDiscount>0</ProductDiscount>
<ProductTotal>10</ProductTotal>
</OD>
</OrderDetails>
</Quote>
</Quotes>
Sample Response
{
"MCM": {
"response": {
"objectType": "Quotes",
"syncTime": "2021-06-10 03:23:14"
},
"parameters": {
"results": {
"message": {
"status": "Success",
"success_message": {
"quote_no": "Test New Quote",
"quote_id": "203060"
}
}
}
}
}
}
<MCM>
<response>
<objectType>Quotes</objectType>
<syncTime>2021-06-10 03:23:14</syncTime>
</response>
<parameters>
<results>
<message>
<status>Success</status>
<success_message>
<quote_no>Test New Quote</quote_no>
<quote_id>203060</quote_id>
</success_message>
</message>
</results>
</parameters>
</MCM>
WADL
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Quote">
<method name="PUT">
<request>
<param name="key" type="xsd:string" style="query" required="true" />
<param name="QuoteNo" type="xsd:int" style="body" required="true" />
<param name="ChannelId" type="xsd:int" style="body" />
<param name="ChannelName" type="xsd:int" style="body" />
<param name="OrderDate" type="xsd:dateTime" style="body" />
<param name="ModifiedDate" type="xsd:dateTime" style="body" />
<param name="Subject" type="xsd:string" style="body" required="true" />
<param name="PotentialName" type="xsd:string" style="body" />
<param name="QuoteStage" type="xsd:string" style="body" />
<param name="ValidTill" type="xsd:date" style="body" />
<param name="CustomerNo" type="xsd:string" style="body" />
<param name="RelatedSO" type="xsd:int" style="body" />
<param name="AccountName" type="xsd:int" style="body" required="true" />
<param name="AccountPhone" type="xsd:string" style="body" />
<param name="AccountEmailAddress" type="xsd:string" style="body" />
<param name="ContactFirstName" type="xsd:string" style="body" required="true" />
<param name="ContactLastName" type="xsd:string" style="body" required="true" />
<param name="ContactPhone" type="xsd:string" style="body" />
<param name="ContactEmailAddress" type="xsd:string" style="body" />
<param name="Team" type="xsd:string" style="body" />
<param name="BillingName" type="xsd:string" style="body" />
<param name="BillingStreet" type="xsd:string" style="body" />
<param name="BillingCity" type="xsd:string" style="body" />
<param name="BillingState" type="xsd:string" style="body" />
<param name="BillingZipCode" type="xsd:string" style="body" />
<param name="BillingCountry" type="xsd:string" style="body" />
<param name="ShipToName" type="xsd:string" style="body" />
<param name="ShipToPhone" type="xsd:string" style="body" />
<param name="ShipToEmailAddress" type="xsd:string" style="body" />
<param name="ShippingStreet" type="xsd:string" style="body" />
<param name="ShippingCity" type="xsd:string" style="body" />
<param name="ShippingState" type="xsd:string" style="body" />
<param name="ShippingZipCode" type="xsd:string" style="body" />
<param name="ShippingCountry" type="xsd:string" style="body" />
<param name="OrderDiscount" type="xsd:decimal" style="body" />
<param name="SubTotal" type="xsd:decimal" style="body" />
<param name="ShippingCost" type="xsd:decimal" style="body" />
<param name="SalesTaxAuthority" type="xsd:string" style="body" />
<param name="SalesTaxes" type="xsd:decimal" style="body" />
<param name="GrandTotal" type="xsd:decimal" style="body" />
<param name="DefaultCurrency" type="xsd:string" style="body" />
<param name="ExchangeRate" type="xsd:decimal" style="body" />
<param name="DefaultPriceBook" type="xsd:string" style="body" />
<param name="AssignedTo" type="xsd:string" style="body" />
<param name="TermsAndConditions" type="xsd:string" style="body" />
<param name="Description" type="xsd:string" style="body" />
<param name="Carrier" type="xsd:string" style="body" />
<param name="ShippingMethod" type="xsd:string" style="body" />
<param name="DeliverFrom" type="xsd:string" style="body" />
<param name="OrderDetails">
<param name="ProductsName" type="xsd:string" style="body" />
<param name="ProductCode" type="xsd:string" style="body" required="true"/>
<param name="ProductSKUCode" type="xsd:string" style="body" />
<param name="ProductNotes" type="xsd:string" style="body"/>
<param name="ProductQty" type="xsd:int" style="body" required="true"/>
<param name="ProductPrice" type="xsd:decimal" style="body"/>
<param name="ProductDiscount" type="xsd:decimal" style="body"/>
<param name="ProductTotal" type="xsd:decimal" style="body"/>
</param>
</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 21 hours ago