Skip to content

Commit b4bb54f

Browse files
authored
Refine Order Quote docs (#88)
1 parent 2b61c3f commit b4bb54f

File tree

1 file changed

+43
-2
lines changed

1 file changed

+43
-2
lines changed

docs/web-apis/ordering-api.mdx

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,50 @@ curl -X GET "https://api.tscircuit.com/orders/get?order_id=123e4567-e89b-12d3-a4
107107
"message": "string"
108108
}
109109
```
110-
- For endpoints related to order quotes, see the Order Quotes API documentation.
110+
## Order Quote API
111+
112+
The Order Quote API lets you retrieve pricing quotes for PCB orders. Quotes include component pricing, PCB costs, shipping options, and overall totals.
113+
114+
### Endpoint
115+
116+
#### Get an Order Quote
117+
`GET /order_quotes/get?order_quote_id={uuid}` or `POST /order_quotes/get`
118+
119+
Request body:
120+
121+
```json
122+
{
123+
"order_quote_id": "string (UUID)"
124+
}
125+
```
126+
127+
Response example:
128+
129+
```json
130+
{
131+
"order_quote": {
132+
"order_quote_id": "123e4567-e89b-12d3-a456-426614174000",
133+
"vendor_name": "jlcpcb",
134+
"is_completed": true,
135+
"quoted_components": [
136+
{
137+
"manufacturer_part_number": "CC0603KRX7R9BB101",
138+
"quantity": 10,
139+
"total_cost": 0.5,
140+
"available": true
141+
}
142+
],
143+
"bare_pcb_cost": 20.0,
144+
"shipping_options": [
145+
{ "carrier": "dhl", "service": "express", "cost": 9.5 }
146+
],
147+
"total_cost_without_shipping": 25.0
148+
}
149+
}
150+
```
151+
152+
Returns `404` if the quote is not found or not accessible.
111153

112154
## See Also
113155

114-
- [Order Quotes API Documentation](#)
115156
- [Authentication Guide](#)

0 commit comments

Comments
 (0)