Skip to content

Retrieve an instant quote

GEThttps://sandbox-api.tryflume.ai/partner/v1/quotes/{quote_uuid}

Returns an instant quote by id, in the same shape as POST /request-instant-quote.

  • 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.

Guide: Get an instant quote

Request

Headers

HeaderRequiredDescription
X-Flume-Partner-KeyYesYour partner key. See Authentication and keys.
X-Flume-User-TokenYesThe access token of the user you call for. See Users and verification.

Path parameters

ParameterTypeDescription
quote_uuidstringThe 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.

  • statusenum

    READY or FAILED.

  • failure_reasonenum or null

    With FAILED: why there are no prices. TEMPORARILY_UNAVAILABLE can mean the quote is still pricing.

    One of
    • NOT_QUOTABLE
    • TEMPORARILY_UNAVAILABLE
    • REGION_RESTRICTED
    • INCORRECT_DESTINATION
  • quote_uuidstring (UUID) or null

    The id to poll with. Send it to GET /quotes/{quote_uuid} while the quote is still pricing. Every response has it.

  • quoteobject or null

    The prices, with READY. Otherwise null.

    ShowHide the 8 fields of quote
    • quote_uuidstring (UUID)

      The quote's id in the user's Flume account.

    • The quote's number, as the user sees it in Flume.

    • sku_uuidstring (UUID)

      The product priced.

    • The delivery ZIP code.

    • currencystring

      Always USD.

      • Default "USD"
    • When the quote was priced, in UTC.

    • The prices hold until this time, in UTC.

    • optionsarray of objects

      One entry per shipping option, cheapest total first.

      ShowHide the 9 fields of options
      • sourceenum

        How this option ships: US_WAREHOUSE or OVERSEAS_DIRECT.

      • ships_from_countrystring or null

        The 2-letter code of the country the option ships from, or null.

      • The shortest delivery time, in days.

      • The longest delivery time, in days.

      • The quantity priced, in square feet.

      • The delivered price per square foot, before tax.

      • subtotalstring

        The delivered price, before tax.

      • sales_taxstring or null

        The sales tax, or null.

      • totalstring

        The delivered price, including sales tax.

Errors

Every error uses one envelope. Branch on error.code.

StatusCodeMeaning
401EMBED_TOKEN_INVALIDYou sent an Authorization header and no X-Flume-Partner-Key. Flume read the call as one from its own iframe.
401PARTNER_KEY_INVALIDThe partner key is missing, unknown, revoked, expired, or from the other environment. On live, also a platform Flume has not enabled yet.
401USER_TOKEN_INVALIDThe user access token is unknown, revoked, another partner's, or replaced by a later verification. A verification in the iframe replaces it too.
403USER_ACCOUNT_CLOSEDThe user's email belongs to a Flume account that Flume has closed.
403USER_NOT_CONNECTEDNo X-Flume-User-Token header was sent.
404NOT_FOUNDThe thing does not exist, or is not this user's. A search id that is not a UUID also returns this code.
422VALIDATION_FAILEDA 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.
500INTERNALSomething failed on Flume's side.