Field List Of Fields and Descriptions
Field Name | Constraints | Description | Table |
|---|---|---|---|
merchant_name | Text | This is the name of the specific gift card merchant. In the event that you are calling for a catalog that will show both fixed and variable offers on the same merchant, there will be a unique record for each offer type on each merchant. | Merchant |
merchant_slug | Text | This is the shortened name for the merchant. It can be used for passing the purchases to Fluz via API for a specific merchant. It is also used to generate the merchant's URL on the Fluz web application. The URL structure is https://fluz.app/store/merchant_slug | Merchant |
updated_at | Date, time stamp | Last update made to that record on the merchant table | Merchant |
created_at | Date, time stamp | Date this merchant was added to our catalog | Merchant |
merchant_status | Active or Inactive | This will indicate if a merchant is available for purchase at this time. A merchant's status can either be active or inactive. If a merchant is archived it will be removed from the catalog export entirely. | Merchant |
logo_url | URL | Image of the merchant logo. This will be a square image of the merchant logo. It will be a vector image at 300 x 300 pixels. | Merchant |
faceplate_image | JSON | JSON obj of images of different sizes for the gift card. This will be the official images of the gift card as provided by the merchant. | Merchant |
primary_color | Hex Code | For merchandising within your experience, Fluz will provide you with the primary color in the merchant logo image. | Merchant |
type | Gift Card or Card Linked Offer | Fluz has both gift card offers and card linked offers. This is based on the specific merchant. Each merchant can have either option. This field will confirm the offer type as either a gift card offer or card linked offer. | Merchant |
category | List | This is the mapping of the merchant within the overall Fluz catalog. | Merchant |
daily_limit-consumer | Number | This is the total maximum dollar amount that can be purchased on a single merchant in a single day. This is by a single user account that is registered as a consumer account. A calendar day is run based off UTC time zones. The limits will reset daily. | Merchant |
daily_limit-commercial | Number | This is the total maximum dollar amount that can be purchased on a single merchant in a single day. This is by a single user account that is registered as a commercial account. A calendar day is run based off UTC time zones. The limits will reset daily. | Merchant |
monthly_limit-consumer | Number | This is the total maximum dollar amount that can be purchased on a single merchant in a single calendar month. This is by a single user account that is registered as a consumer account. A calendar month is run based off UTC time zones. It will run from the first of the month to the last day of the calendar month. The limits will reset monthly. | Merchant |
monthly_limit-commercial | Number | This is the total maximum dollar amount that can be purchased on a single merchant in a single calendar month. This is by a single user account that is registered as a consumer account. A calendar month is run based off UTC time zones. It will run from the first of the month to the last day of the calendar month. The limits will reset monthly. | Merchant |
website_url | URL | This is URL of that specific merchant. Please note, if the merchant has multiple URLs or sub domains, Fluz will be providing a single URL for that given merchant. | Merchant |
redemption_information | Text | These are details on how to redeem the gift card at that specific merchant. These can be specific | Merchant |
parent_company | Text | If the specific merchant's gift card is able to be used at other retail brands, we will list the name of the parent company that | Merchant |
redeemable_at_other_brands | List | What other merchants this gift card is redeemable at. Sometimes it will be other child merchants under the same parent merchant. But other times it will be an assortment of merchants for a multi brand card. Examples: Uber gift cards are redeemable at Uber + Uber Eats Gap gift cards are redeemable at Gap + Old Navy + Banana Republic + Athleta Happy Card Retail Therapy cards are redeemable at Lululemon, Macys, Nike, Boohoo, etc | Merchant |
merchant_gift_card_redemption_url | Text | If the merchant has a specific URL to apply the gift card balance directly to your account with that merchant, that specific URL will be provided in this field. | Merchant |
description | Text | This is the fully fleshed out description of the merchant. | Merchant |
short_description | Text | This is the shortened version of the description on that merchant. | Merchant |
merchant_support_phone_number | Phone Number | If the merchant provides a dedicated phone number address to support issues regarding their gift card program, that information will be provided here. | Merchant |
merchant_support_email | Email address | If the merchant provides a dedicated email address to support issues regarding their gift card program, that information will be provided here. | Merchant |
Field Name | Constraints | Description | Table |
|---|---|---|---|
offer_id | UUID | This is the public offer ID that you will reference | Offer |
rate | number | This is the best rate on the respective merchant. If the fixed and variable have the same rate, then just include the variable. If variable is less than fixed value, include both the variable and fixed value offers, unless you are calling the catalog that just has the variable value offers only. In the event that the merchant has multiple different fixed value denomination offers with different rates, this will have a separate offer for each denomination + rate combo. | Offer |
denomination_type | Fixed or Variable | This field will be corresponding to the denomination of that particular offer. Each highest value offer will have their own record. | Offer |
denominations | number range | This field will be corresponding to the denomination of that particular offer.
| Offer |
card_format | URL or code | Some of merchants only allow for a hosted URL for the gift card delivery. In that case, we will tell you the format you can expect. | Offer |
barcode_type | 128, UPC, QR, None | Some retailers require a barcode or QR code and some of these retailers require manipulation of the gift code to produce the barcode 'number', such as having a prefix, dropping some digits, or adding the PIN. To remove this complexity from our clients we return the barcode information in our Issue response data. | Offer |
currency | Text | This is the currency that the value on the gift card is tied to. | Offer |
countries | Country list | This is saying which countries the gift cards can be redeemed in Please note that the underlying value on each gift card will be tied to the currency listed on the gift card. Even if it works in other countries that generally operate in a different currency, the value will be tied to the listed currency. | Offer |
gift_card_expiration_window | Number | This is the amount of months that the gift card expires in. This is based on the months from card issuance. If null, that means that the gift card does not expire. | Offer |
merchant_terms | Text | These are the terms of use provided by the merchant on the terms of use for the specific merchant's gift card program. | Offer |
Updated 3 months ago