What is the Fluz API?
Using the Offer
object from either the getOfferQuote
or getMerchants
query, you can determine stock availability.
-
If
hasStockInfo
is true, thestockInfo
field will display a list of all available denominations that are currently in stock. -
If
hasStockInfo
is false, any value denominations in theofferRates
denominations
field will be in stock. -
If the
denominationsType
is"VARIABLE"
, you can purchase any value between the minimum and maximum denomination. -
stockInfo
is a list of available denominations for a specific offer. This field object is only available if the offer's hasStockInfo is true. This requires Fluz to confirm the inventory. Keep in mind, the response time varies by vendors. The stockInfo field will conditionally return information depending on theVARIABLE
orFIXED
type. To query for stockInfo, you will need to utilize an inline fragment using the... on
keyword. This will returnStockInfoVariableType
if the denomination type isVARIABLE
orStockInfoFixedType
if the denomination type isFIXED
.\In your getOfferQuote and getMerchants queries, you will have to include both StockInfoVariableType and StockInfoFixedType fragments.
For more detail, refer to the Using Fragments with Unions and Interfaces article.
"offerRates":[{
"denominations": ["10","1000"]
}]
-
If the
denominationsType
is"FIXED"
, you will either:- If
hasStockInfo
is true, purchase a specific value in thestockInfo
field. It will return eitherStockInfoVariableType
orStockInfoFixedType
conditionally depending on thedenominationsType
.\
"stockInfo": { "__typename": "StockInfoVariableType", "description": "Available denominations range from $5 to $200", "maxDenomination": "200", "minDenomination": "5" } ,
"stockInfo": [ { "__typename": "StockInfoFixedType", "availableStock": "200", "denomination": "5" } ]
- If
hasStockInfo
is false, purchase a specific value in theofferRates
denominations
field.\
"offerRates": [{ "denominations": ["10","100"] }]
- If
Next Steps
Now it's time to purchase a gift card. But first, let's make sure you can fund your purchase. Learn how to do so here:
Updated 2 months ago