{"swagger":"2.0","info":{"description":"[27coupons.com](https://www.27coupons.com/) is one of the largest aggregators of coupons and offers in India. We offer access to our data allowing developers to build upon and extend their applications in new and creative ways. Our API framework is built upon REST architecture. \n\n **Authentication** \n 27coupons supports api key authentication and key has to be sent in query string. Visit https://www.27coupons.com/account/api/ to generate your api key.\n\n**Response Format**\n json is the default response format.\n * Every call is logged and **status_id** is returned to help in error tracking and debugging. \n * **status_code** is 200 for a successful request, 401 for authentication failure, 403 when rate limited, 404 to indicate not-found responses, and 400 for all other invalid requests or responses. \n * **status_txt** will be a value that describes the nature of any error encountered. \n\n **Rate Limiting** \n Our standard rate limit is 100 calls. You can write to our support team and let us know your business case for accessing our API and we will increase it.\n \n**SDKs**\nphp [https://github.com/27coupons/php-sdk](https://github.com/27coupons/php-sdk)","version":"2.0","title":"27coupons API","termsOfService":"https://www.27coupons.com/terms/","contact":{"email":"cs@27coupons.com"}},"host":"api.27coupons.com","basePath":"/v2.0","tags":[{"name":"data","description":"Coupons Data"}],"schemes":["https"],"paths":{"/data/search-stores/":{"get":{"tags":["data"],"description":"**Search Stores**","operationId":"searchStores","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"store id","required":false,"type":"integer"},{"name":"name","in":"query","description":"store name should be minimum 3 and 15 characters in length, else it will be ignored.","required":false,"type":"string"},{"name":"zero_coupons","in":"query","description":"0: stores with number of coupons greater than zero, 1: all stores","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: popular stores, 1: number of coupons, 2: store name","type":"integer","required":false,"default":0,"enum":[0,1,2]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchStores"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/search-categories/":{"get":{"tags":["data"],"description":"**Search Categories**","operationId":"searchCategories","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"category id","required":false,"type":"integer"},{"name":"name","in":"query","description":"category name should be minimum 3 and 15 characters in length, else it will be ignored.","required":false,"type":"string"},{"name":"zero_coupons","in":"query","description":"0: categories with number of coupons greater than 0, 1: all categories","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: number of coupons, 1: category name","type":"integer","required":false,"default":0,"enum":[0,1]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchCategories"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/search-banks/":{"get":{"tags":["data"],"description":"**Search Banks**","operationId":"searchBanks","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"bank id","required":false,"type":"integer"},{"name":"name","in":"query","description":"bank name should be between 3 and 15 characters in length, else it will be ignored.","required":false,"type":"string"},{"name":"zero_coupons","in":"query","description":"0: banks with number of coupons greater than zero, 1: all banks","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: number of coupons, 1: bank name","type":"integer","required":false,"default":0,"enum":[0,1]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchTaxonomies"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/search-wallets/":{"get":{"tags":["data"],"description":"**Search Wallets**","operationId":"searchWallets","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"wallet id","required":false,"type":"integer"},{"name":"name","in":"query","description":"wallet name should be between 3 and 15 characters in length, else it will be ignored.","required":false,"type":"string"},{"name":"zero_coupons","in":"query","description":"0: wallets with number of coupons greater than zero, 1: all wallets","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: number of coupons, 1: wallet name","type":"integer","required":false,"default":0,"enum":[0,1]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchTaxonomies"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/search-cards/":{"get":{"tags":["data"],"description":"**Search Cards**","operationId":"searchCards","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"card id","required":false,"type":"integer"},{"name":"name","in":"query","description":"card name should be between 3 and 15 characters in length, else it will be ignored.","required":false,"type":"string"},{"name":"zero_coupons","in":"query","description":"0: cards with number of coupons greater than zero, 1: all cards","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: number of coupons, 1: card name","type":"integer","required":false,"default":0,"enum":[0,1]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchTaxonomies"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/search-coupons/":{"get":{"tags":["data"],"description":"**Search Coupons** \n Search and filter coupons by stores, categories, banks, wallets and cards. You can also get data of selected coupons by id. To filter by multiple ids, please pass the list of ids in csv format.","operationId":"searchCoupons","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"coupon_type","in":"query","description":"0: all coupons (coupon + offer), 1: coupons only, 2: offers only","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"coupon_ids","in":"query","description":"id of coupons separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"store_ids","in":"query","description":"id of stores separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"category_ids","in":"query","description":"id of categories separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"bank_ids","in":"query","description":"id of banks separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"wallet_ids","in":"query","description":"id of wallets separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"card_ids","in":"query","description":"id of cards separated by comma in csv format. example: 1,2,3","required":false,"type":"string"},{"name":"bank_coupons","in":"query","description":"0: non bank coupons only, 1: only bank coupons, 2: all coupons (bank + non bank)","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"wallet_coupons","in":"query","description":"0: non wallet coupons only, 1: only wallet coupons, 2: all coupons (wallet + non wallet)","required":false,"type":"integer","default":0,"enum":[0,1]},{"name":"sort_by","in":"query","description":"index of sort by columns. 0: popular, 1: freshness, 2: expiry date, 3: store name, 4: coupon title","type":"integer","required":false,"default":0,"enum":[0,1]},{"$ref":"#/parameters/SortTypeQuery"},{"$ref":"#/parameters/PaginateRecords"},{"$ref":"#/parameters/PaginatePage"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/SearchCoupons"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/get-coupon/":{"get":{"tags":["data"],"description":"**Get Coupon**","operationId":"getCoupon","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"id","in":"query","description":"id of coupon","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/GetCoupon"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}},"/data/trending-coupons/":{"get":{"tags":["data"],"description":"**Trending Coupons** \n Returns data of trending coupons. Maximum 20 coupons are returned.","operationId":"trendingCoupons","consumes":["application/json"],"produces":["application/json"],"security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/TrendingCoupons"}},"400":{"description":"bad request","schema":{"$ref":"#/definitions/Errors"}},"401":{"description":"auth error","schema":{"$ref":"#/definitions/Errors"}},"403":{"description":"rate limit","schema":{"$ref":"#/definitions/Errors"}},"404":{"description":"resource not found","schema":{"$ref":"#/definitions/Errors"}},"500":{"description":"application error","schema":{"$ref":"#/definitions/Errors"}}}}}},"securityDefinitions":{"ApiKeyAuth":{"type":"apiKey","name":"api_key","in":"query"}},"definitions":{"Errors":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"}}},"SearchCoupons":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/CouponData"}},"pagination":{"$ref":"#/definitions/Pagination"}}},"GetCoupon":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"$ref":"#/definitions/CouponData"}}},"TrendingCoupons":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"type":"array","items":{"$ref":"#/definitions/CouponData"}}}},"CouponData":{"type":"object","properties":{"id":{"description":"coupon id","type":"integer"},"coupon_type":{"description":"coupon type, 1: coupon with code, 2: coupon without code","type":"integer"},"coupon_type_name":{"description":"coupon type in string","type":"string"},"coupon_code":{"description":"coupon code. this field will be blank for offers","type":"string"},"title":{"description":"coupon title","type":"string"},"description":{"description":"coupon description, may contain new line character","type":"string"},"store_id":{"description":"store id","type":"integer"},"store_name":{"description":"store name","type":"string"},"store_img_url":{"description":"url of store logo","type":"string"},"url":{"description":"url of coupon landing page or store","type":"string"},"bank_coupon":{"description":"0: non-bank coupon, 1: bank coupon","type":"integer"},"wallet_coupon":{"description":"0: non-wallet coupon, 1: wallet coupon","type":"integer"},"category_ids":{"description":"array of category id","type":"array","items":{"type":"integer"}},"category_data":{"description":"array of category data containing id and name","type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"bank_ids":{"description":"array of bank id","type":"array","items":{"type":"integer"}},"bank_data":{"description":"array of bank data containing id and name","type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"wallet_ids":{"description":"array of wallet id","type":"array","items":{"type":"integer"}},"wallet_data":{"description":"array of wallet data containing id and name","type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"card_ids":{"description":"array of card id","type":"array","items":{"type":"integer"}},"card_data":{"description":"array of card data containing id and name","type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}}},"status_id":{"description":"coupon status. 0:expired, 1:active","type":"integer"},"status_name":{"description":"coupon status. expired/active","type":"string"},"expiry_ts":{"description":"expiry date of the coupon in unix timestamp","type":"integer"},"expiry_date":{"description":"expiry date of the coupon [dd-mmm-yyyy]","type":"string"},"ts":{"description":"last updated date in unix timestamp","type":"integer"}}},"SearchStores":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"id of store","type":"integer"},"name":{"description":"name of store","type":"string"},"url":{"description":"url of store","type":"string"},"img_url":{"description":"url of store logo","type":"string"},"num_coupons":{"description":"number of coupons","type":"integer"}}}},"pagination":{"$ref":"#/definitions/Pagination"}}},"SearchTaxonomies":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"id","type":"integer"},"name":{"description":"name","type":"string"},"img_url":{"description":"url of logo","type":"string"},"num_coupons":{"description":"number of coupons","type":"integer"}}}},"pagination":{"$ref":"#/definitions/Pagination"}}},"SearchCategories":{"type":"object","properties":{"status_code":{"type":"integer"},"status_id":{"type":"string"},"status_txt":{"type":"string"},"rate_limit":{"$ref":"#/definitions/RateLimit"},"data_count":{"type":"integer"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"id","type":"integer"},"name":{"description":"name","type":"string"},"num_coupons":{"description":"number of coupons","type":"integer"}}}},"pagination":{"$ref":"#/definitions/Pagination"}}},"Pagination":{"type":"object","properties":{"sort_by":{"description":"index of sorted column","type":"integer"},"sort_type":{"description":"0 for ascending and 1 for descending","type":"integer"},"num_records":{"description":"number of records per page","type":"integer"},"total_records":{"description":"total number of records found","type":"integer"},"page":{"description":"current page number","type":"integer"}}},"RateLimit":{"type":"object","properties":{"total":{"description":"api calls limit","type":"integer"},"consumed":{"description":"number of api calls consumed","type":"integer"}}}},"parameters":{"SortTypeQuery":{"name":"sort_type","in":"query","description":"0: ascending, 1: descending","type":"integer","required":false,"default":1,"enum":[0,1]},"PaginateRecords":{"name":"num_records","in":"query","description":"number of records per page, max 100","type":"integer","required":false,"minimum":1,"maximum":100,"default":10},"PaginatePage":{"name":"page","in":"query","description":"page number for pagination","type":"integer","required":false,"minimum":1,"default":1}}}