Brand

1. Get Brands

This APIs returns all the brands(SKUs) that are enabled for the partner and also matching the filter criteria.

• Endpoint: /v1/partners/products
• Method: GET
• Description: Returns all activated brands for the client.
• Query Parameters:
  • q: For text search on
  • category : category filter
  • pageNo : page number for pagination - starts from 1. If this is not sent, all the activated brands will be returned
  • limit : size of the page
• Note: usageInstructions will be deprecated going forward. Please use howToUseInstructions instead.

Response Body

{
  "data": [
    {
      "id": "01GMAW822RPDJ5C50XK24QC2C4",
      "status": "ACTIVE",
      "title": "Zomato",
      "brandDescription": "Zomato connects you with a wide range of restaurants for home delivery and dining out, enhancing your culinary experiences.",
      "category": ["POPULAR_BRANDS", "TOP_BRANDS", "FOOD"],
      "tags": [
        "Food",
        "Food Delivery",
        "Restaurants",
        "Cuisine",
        "FastFood",
        "Pizza",
        "Burgers",
        "Sushi",
        "Chinese",
        "Indian",
        "Italian",
        "Mexican",
        "Thai",
        "Vegetarian",
        "Vegan",
        "GlutenFree"
      ],
      "denominationType": "FLEXIBLE",
      "cardType": "CARD_AND_PIN_NO_SECURED",
      "redemptionType": "ONLINE",
      "amountRestrictions": {
        "minAmount": 250,
        "maxAmount": 10000,
        "minOrderAmount": 250,
        "maxOrderAmount": 10000,
        "minVoucherAmount": 250,
        "maxVoucherAmount": 10000,
        "maxVouchersPerOrder": 4,
        "maxVouchersPerDenomination": null,
        "maxDenominationsPerOrder": null,
        "denominations": null
      },
      "iconImageUrl": "https://assets.myhubble.money/brand-assets/tile-images-wp/zomato-tile.webp",
      "thumbnailUrl": "https://assets.myhubble.money/brand-assets/tile-images-sq-wp/599-zomato-0xv6zd.webp",
      "logoUrl": "https://assets.myhubble.money/brand-assets/sq-logo-images-wp/599-zomato-enhyc4.webp",
      "tncUrl": "https://flow.myhubble.money/brands-v6s/zomato-gift-card",
      "termsAndConditions": [
        "Comes with 1 year validity. The gift card can be used multiple times",
        "Users can add multiple gift cards to Zomato Money at once",
        "Max. ₹25,000 per month can be loaded into Zomato Money; sometimes giftcards may take 24 hours to activate"
      ],
      "usageInstructions": {
        "ONLINE": [
          "Open the Zomato app and click on “Profile”",
          "In the money section, click on “Claim gift card”",
          "Enter the 16 digit card number and 6 digit pin and tap on claim",
          "The amount of the gift card can now be used at checkout"
        ]
      },
      "howToUseInstructions": [
        {
          "retailMode": "ONLINE",
          "retailModeName": "Online",
          "instructions": [
            "Open the Zomato app and click on “Profile”",
            "In the money section, click on “Claim gift card”",
            "Enter the 16 digit card number and 6 digit pin and tap on claim",
            "The amount of the gift card can now be used at checkout"
          ]
        }
      ],
      "canBalanceBeFetched": false,
      "voucherExpiryInMonths": 12,
      "variantDetails": []
    }
  ],
  "nextCursor": {
    "pageNo": 1,
    "limit": 20
  }
}

Notes

• The fields minAmount and maxAmount in the amountRestrictions object are deprecated. Please use minOrderAmount and maxOrderAmount instead.

• If denominations is null in the amountRestrictions object, it indicates a flexible denomination brand where any amount within the min/max range is allowed. If denominations contains values, it is a fixed denomination brand and only those specific denomination values are accepted. This is also indicated in the denominationType field.

• Please use retailModeName for display purposes instead of the retailMode enum.

2. Get Brand By Id

• Endpoint: /v1/partners/products/:productId
• Description: Returns an individual product based on the ID.
• Method: GET

Response Body

{
  "id": "brand_id",
  "status": "ACTIVE/INACTIVE",
  "title": "Brand Title",
  "categories": ["Brand Category"],
  "tags": ["tag1", "tag2"],
  "denominationType": "FIXED/FLEXIBLE",
  "cardType": "PIN_SECURED/CARD_NO_AND_PIN",
  "redemptionType": "OFFLINE/ONLINE/ONLINE_AND_OFFLINE",
  "amountRestrictions": {
    "minOrderAmount": 100,
    "maxOrderAmount": 5000,
    "minVoucherAmount": 100,
    "maxVoucherAmount": 1000,
    "maxVouchersPerOrder": 5,
    "maxVouchersPerDenomination": 1,
    "maxDenominationsPerOrder": 1,
    "denominations": [100, 1000, 5000]
  },
  "thumbnailUrl": "https://assets.myhubble.money/brand-assets/tile-images-sq-wp/499-swiggy-w024zl.webp",
  "termsAndConditions": [
    "Comes with 1 year validity",
    "Max. ₹10000 per month can be loaded in Swiggy Wallet for users with minimum KYC",
    "Max. 1 lac INR per month can be loaded in Swiggy Wallet for users with full KYC"
  ],
  "usageInstructions": {
    "ONLINE": [
      "Comes with 1 year validity",
      "Max. ₹10000 per month can be loaded in Swiggy Wallet for users with minimum KYC",
      "Max. 1 lac INR per month can be loaded in Swiggy Wallet for users with full KYC"
    ],
    "OFFLINE": ["Comes with 1 year validity"]
  },
  "howToUseInstructions": [
    {
      "retailMode": "ONLINE",
      "retailModeName": "Offline",
      "instructions": [
        "Visit the outlet near you.",
        "At the billing counter inform cashier that you want to use Gift Card.",
        "Show your Gift Card details & pay any balance amount by cash or card."
      ]
    },
    {
      "retailMode": "OFFLINE",
      "retailModeName": "Online",
      "instructions": [
        "On www.ikea.com add products to you cart",
        "Before purchasing GC, please ensure that IKEA delivers to your location",
        "To check, please follow these steps: https://coda.io/@sharad/does-ikea-deliver-to-my-location",
        "Alternatively, you can check your PIN code against this list: https://coda.io/@sharad/ikea-servicable-pin-codes",
        "Proceed to checkout, in the payment section, select Redeem an IKEA gift card",
        "Enter the gift card details, complete checkout."
      ]
    }
  ]
}