Quotes: Overview
Swagger Definition
The Swagger definition for this version of the Quotes API can be found at: https://app.swaggerhub.com/apis/Triquestra/quotes/3.0.
Overview
The Quotes API enables the creation, retrieval and update of quotations provided to customers.
Using the Quotes API you can:
- Create, update and retrieve individual quotes.
- Retrieve recently updated quotes.
- Search for quotes.
The Quotes API is composed of the following:
- Quotes: A quotation provided to a customer for good and services. A quote header has an expiration date and can expire, be marked as lost, or won. Quote lines list the individual products, quantities, and selling prices.
Examples
Create a quote using the PUT endpoint without an existing quote code:
PUT /quotes/1030010005317
{
"quote_status": "Active",
"quote_version": 1,
"loyalty_account_code": "1186516036",
"expiry_date": "2023-07-20",
"lines": [
{
"line_number": 1,
"line_version": 1,
"product_code": "1000030",
"quantity": 1,
"unit_selling_price": 10,
"standard_unit_selling_price":10
}
]
}
Update an existing quote using the PUT endpoint with an existing quote code:
PUT /quotes/1030010005317
Retrieve an individual quote:
GET /quotes/1030010005317
Retrieve a list of recently updated quotes for a specific site:
GET /quotes?customer_site_code=103&updated_since=2023-06-06
Search for recently created quotes:
POST /quotes/search
{
"created": {
"date_from": "2023-01-01T00:00:00Z",
"date_to":"2023-06-06T00:00:00Z"
}
}
Security Risk Profile
Financial Data 0: no financial data exposed.
Personal Data 1: quote notes might contain personal data.
Business Data 2: quote transactions are exposed and can be updated.