- Use it to poll a quote that is still pricing.
- Poll every 12 seconds for 2 minutes, then every 30 seconds until 5 minutes, then stop.
- No daily limit is used.
- Docs
- API reference
- Quotes
- Retrieve an instant quote
Retrieve an instant quote
Code samples show live values. Live is in early access and not yet open to new partners: see Environments.
https://sandbox-api.tryflume.ai/partner/v1/quotes/{quote_uuid}Returns an instant quote by id, in the same shape as POST /request-instant-quote.
Guide: Get an instant quote
Request
Headers
| Header | Required | Description |
|---|---|---|
X-Flume-Partner-Key | Yes | Your partner key. See Authentication and keys. |
X-Flume-User-Token | Yes | The access token of the user you call for. See Users and verification. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
quote_uuid | string | The quote's id, from POST /request-instant-quote. |
This call takes no body.
Returns
200 with these fields. Every field is always present. A field with no value is null.
statusenumREADYorFAILED.failure_reasonenum or nullWith
FAILED: why there are no prices.TEMPORARILY_UNAVAILABLEcan mean the quote is still pricing.One ofNOT_QUOTABLETEMPORARILY_UNAVAILABLEREGION_RESTRICTEDINCORRECT_DESTINATION
quote_uuidstring (UUID) or nullThe id to poll with. Send it to
GET /quotes/{quote_uuid}while the quote is still pricing. Every response has it.quoteobject or nullThe prices, with
READY. Otherwisenull.ShowHide the 8 fields of
quotequote_uuidstring (UUID)The quote's id in the user's Flume account.
quote_numberstringThe quote's number, as the user sees it in Flume.
sku_uuidstring (UUID)The product priced.
destination_zipstringThe delivery ZIP code.
currencystringAlways
USD.- Default
"USD"
- Default
created_atstringWhen the quote was priced, in UTC.
valid_untilstringThe prices hold until this time, in UTC.
optionsarray of objectsOne entry per shipping option, cheapest
totalfirst.ShowHide the 9 fields of
optionssourceenumHow this option ships:
US_WAREHOUSEorOVERSEAS_DIRECT.ships_from_countrystring or nullThe 2-letter code of the country the option ships from, or
null.lead_time_min_daysintegerThe shortest delivery time, in days.
lead_time_max_daysintegerThe longest delivery time, in days.
quantity_sqftstringThe quantity priced, in square feet.
price_per_sqftstringThe delivered price per square foot, before tax.
subtotalstringThe delivered price, before tax.
sales_taxstring or nullThe sales tax, or
null.totalstringThe delivered price, including sales tax.
Errors
Every error uses one envelope. Branch on error.code.
| Status | Code | Meaning |
|---|---|---|
| 401 | EMBED_TOKEN_INVALID | You sent an Authorization header and no X-Flume-Partner-Key. Flume read the call as one from its own iframe. |
| 401 | PARTNER_KEY_INVALID | The partner key is missing, unknown, revoked, expired, or from the other environment. On live, also a platform Flume has not enabled yet. |
| 401 | USER_TOKEN_INVALID | The user access token is unknown, revoked, another partner's, or replaced by a later verification. A verification in the iframe replaces it too. |
| 403 | USER_ACCOUNT_CLOSED | The user's email belongs to a Flume account that Flume has closed. |
| 403 | USER_NOT_CONNECTED | No X-Flume-User-Token header was sent. |
| 404 | NOT_FOUND | The thing does not exist, or is not this user's. A search id that is not a UUID also returns this code. |
| 422 | VALIDATION_FAILED | A field is missing, unknown or has an unusable value. field names it as a dotted path. Some refusals carry the detail in details and leave field empty. |
| 500 | INTERNAL | Something failed on Flume's side. |