Quotes
Convert quote to shipment
Convert an accepted quote into a shipment.
What happens
- Quote status is set to WON (if not already)
- A new Shipment is created
- The Order from the quote is linked to the shipment
- Optionally, additional orders can be added
Prerequisites
- Quote must be in QUOTED or WON status
- Quote cannot already have a shipment
Response
Returns the IDs of both the quote and the newly created shipment.
post/quotes/{id}/convert-to-shipment
Path parameters
idstring required
Resource ID (UUID) or client key
Query parameters
by'id' | 'key'
Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.
Request body
Example request
{
"additionalOrders": [
{
"stops": [
{
"address": {
"line1": "123 Main St",
"line2": "Suite 400",
"city": "Chicago",
"country": "USA",
"market": "CHI",
"latitude": "41.8781",
"longitude": "-87.6298",
"isSmartyValidated": true,
"obeysDst": true
}
}
]
}
]
}Response
Quote converted to shipment successfully