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
Response Body
{ "data": [ { "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": { "minAmount": 100, "maxAmount": 5000, "maxVouchersPerOrder": 5, "maxDenominationsPerOrder": 1, "denominations": [ 100, 1000, 5000 ] }, "iconImageUrl": "https://assets.myhubble.money/brand-assets/icon-images/swiggy.png", "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" ] } } ], "nextCursor": { "pageNo": 1, "limit": 20 }}
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": { "minAmount": 100, "maxAmount": 5000, "maxVouchersPerOrder": 5, "maxDenominationsPerOrder": 1, "denominations": [ 100, 1000, 5000 ] }, "iconImageUrl": "https://assets.myhubble.money/brand-assets/icon-images/swiggy.png", "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" ] }}