Read Quote
Retrieves the details of a Quote object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=QuoteStage,eq,Created;Test CheckBox,eq,0&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=OrderDate,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=OrderDate,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=DeliverFrom,eq,OAK OR PDX&key=xyzkey List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/Quote?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=QuoteStage,eq,Created;Test CheckBox,eq,0&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/Quote?filter=QuoteStage,eq,Created;Test CheckBox,eq,0&pageSize=10&key=xyzkey |
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",
"OrderDateUTC": "01-24-2020 15:01:35",
"ModifiedDate": "2020-12-10 04:11:58",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"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"
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<Quotes>
<Quote>
<QuoteId>200530</QuoteId>
<QuoteNo>120</QuoteNo>
<ChannelId>123</ChannelId>
<ChannelName>Amazon</ChannelName>
<OrderDate>2020-12-10 03:12:44</OrderDate>
<OrderDateUTC>01-24-2020 15:01:35</OrderDateUTC>
<ModifiedDate>2020-12-10 04:11:58</ModifiedDate>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<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>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</Quotes>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40/">
<resource path="Quote">
<method name="GET">
<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 about 22 hours ago