130 lines
3.2 KiB
Markdown
130 lines
3.2 KiB
Markdown
---
|
|
name: quotes-routes
|
|
description: Handle 10 OpenAPI operation(s) under /v1/quotes for the quotes route group.
|
|
---
|
|
|
|
# quotes API Routes
|
|
|
|
Handle 10 OpenAPI operation(s) under /v1/quotes for the quotes route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_quotes
|
|
|
|
- Operation ID: `get_quotes`
|
|
- Route: `GET /v1/quotes`
|
|
- Mode: READ
|
|
- Summary: List all quotes
|
|
- Parameters:
|
|
- `customer` in `query`
|
|
- `customer_account` in `query`
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `starting_after` in `query`
|
|
- `status` in `query`
|
|
- `test_clock` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_quotes
|
|
|
|
- Operation ID: `post_quotes`
|
|
- Route: `POST /v1/quotes`
|
|
- Mode: WRITE
|
|
- Summary: Create a quote
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_quotes_quote
|
|
|
|
- Operation ID: `get_quotes_quote`
|
|
- Route: `GET /v1/quotes/{quote}`
|
|
- Mode: READ
|
|
- Summary: Retrieve a quote
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_quotes_quote
|
|
|
|
- Operation ID: `post_quotes_quote`
|
|
- Route: `POST /v1/quotes/{quote}`
|
|
- Mode: WRITE
|
|
- Summary: Update a quote
|
|
- Parameters:
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_quotes_quote_accept
|
|
|
|
- Operation ID: `post_quotes_quote_accept`
|
|
- Route: `POST /v1/quotes/{quote}/accept`
|
|
- Mode: WRITE
|
|
- Summary: Accept a quote
|
|
- Parameters:
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_quotes_quote_cancel
|
|
|
|
- Operation ID: `post_quotes_quote_cancel`
|
|
- Route: `POST /v1/quotes/{quote}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: Cancel a quote
|
|
- Parameters:
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_quotes_quote_computed_upfront_line_items
|
|
|
|
- Operation ID: `get_quotes_quote_computed_upfront_line_items`
|
|
- Route: `GET /v1/quotes/{quote}/computed_upfront_line_items`
|
|
- Mode: READ
|
|
- Summary: Retrieve a quote's upfront line items
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `quote` in `path` required
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### post_quotes_quote_finalize
|
|
|
|
- Operation ID: `post_quotes_quote_finalize`
|
|
- Route: `POST /v1/quotes/{quote}/finalize`
|
|
- Mode: WRITE
|
|
- Summary: Finalize a quote
|
|
- Parameters:
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_quotes_quote_line_items
|
|
|
|
- Operation ID: `get_quotes_quote_line_items`
|
|
- Route: `GET /v1/quotes/{quote}/line_items`
|
|
- Mode: READ
|
|
- Summary: Retrieve a quote's line items
|
|
- Parameters:
|
|
- `ending_before` in `query`
|
|
- `expand` in `query`
|
|
- `limit` in `query`
|
|
- `quote` in `path` required
|
|
- `starting_after` in `query`
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_quotes_quote_pdf
|
|
|
|
- Operation ID: `get_quotes_quote_pdf`
|
|
- Route: `GET /v1/quotes/{quote}/pdf`
|
|
- Mode: READ
|
|
- Summary: Download quote PDF
|
|
- Parameters:
|
|
- `expand` in `query`
|
|
- `quote` in `path` required
|
|
- Body: JSON request body accepted.
|