The Merchant API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
\nYou can use the Merchant API in test mode, which does not affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11678919","collectionId":"c4cce7bf-9c5c-4006-8435-1d7a45041d95","publishedId":"Szzg8yeG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-06-11T06:15:56.000Z"},"item":[{"name":"Authentication","item":[],"id":"bf981ee2-6348-4a61-9dd7-8671866a85bd","description":"The Merchant API uses API keys to authenticate requests. You can view and manage your API keys in the dashboard.
\nTest mode secret keys have the prefix sk_test_ and live mode secret keys have the prefix sk_live_. Alternatively, you can use restricted API keys for granular permissions.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nAuthentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.
\n","_postman_id":"bf981ee2-6348-4a61-9dd7-8671866a85bd"},{"name":"Errors","item":[],"id":"36a43001-78d1-46b9-b138-06134411fb80","description":"Merchant API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Merchant API's servers (these are rare).
\nSome 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.
\n\n\n200 - OK Everything worked as expected.
\n
\n\n400 - Bad Request The request was unacceptable, often due to missing a required parameter.
\n
\n\n401 - Unauthorized No valid API key provided.
\n
\n\n402 - Request Failed The parameters were valid but the request failed.
\n
\n\n403 - Forbidden The API key doesn't have permissions to perform the request.
\n
\n\n404 - Not Found The requested resource doesn't exist.
\n
\n\n409 - Conflict The request conflicts with another request (perhaps due to using the same idempotent key).
\n
\n\n429 - Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
\n
\n\n","event":[{"listen":"prerequest","script":{"id":"de3fbdca-d34a-4a13-a2ef-9447f0a714b4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72842e3f-b47b-4a49-9615-a1b4737266e2","type":"text/javascript","exec":[""]}}],"_postman_id":"36a43001-78d1-46b9-b138-06134411fb80"},{"name":"Idempotent Requests","item":[],"id":"a200dc3d-f489-4aea-b80d-3ba670e83e58","description":"500, 502, 503, 504 - Server Errors Something went wrong on our end. (These are rare.)
\n
The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to retrieve the fulfillment options for a merchant, you can retry the request with the same idempotency key to guarantee that no more than one charge is created.
\nTo perform an idempotent request, provide an additional Idempotency-Key: header to the request.
\nMerchant API's idempotency works by saving the resulting status code and body of the first request made for any given idempotency key, regardless of whether it succeeded or failed. Subsequent requests with the same key return the same result, including 500 errors.
\n","_postman_id":"a200dc3d-f489-4aea-b80d-3ba670e83e58"},{"name":"Pagination","item":[],"id":"76e319c4-f2ae-4a84-b9cb-e2027607c2e2","description":"All top-level API resources have support for bulk fetches via \"list\" API methods. For instance, you can list merchants, offers, and list connected merchants. These list API methods share a common structure, taking at least these three parameters: limit, starting_after, and ending_before.
\nMerchant API utilizes cursor-based pagination via the starting_after and ending_before parameters. Both parameters take an existing object ID value (see below) and return objects in reverse chronological order. The ending_before parameter returns objects listed before the named object. The starting_after parameter returns objects listed after the named object. These parameters are mutually exclusive -- only one of starting_after or ending_before may be used.
\nOur client libraries offer auto-pagination helpers to easily traverse all pages of a list.
\n","_postman_id":"76e319c4-f2ae-4a84-b9cb-e2027607c2e2"},{"name":"Request IDs","item":[],"id":"eab780b8-fbec-4708-aa56-b8721505e828","description":"Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.
\n","_postman_id":"eab780b8-fbec-4708-aa56-b8721505e828"},{"name":"Versioning","item":[],"id":"ab183816-486a-4c76-a897-b27266cd4ccf","description":"When backwards-incompatible changes are made to the API, a new, dated version is released. Read our API upgrades guide to see our API changelog and to learn more about backwards compatibility.
\nAll requests use your account API settings, unless you override the API version. The changelog lists every available version. Note that by default webhook events are structured according to your account API version, unless you set an API version during endpoint creation.
\nTo set the API version on a specific request, send a API-Version header.
\n","_postman_id":"ab183816-486a-4c76-a897-b27266cd4ccf"},{"name":"API Endpoints","item":[{"name":"Categories","item":[{"name":"categories","id":"7b074e73-fd62-47fc-87aa-4954cde62fd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"Required parameters: API key
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"c96f3e89-7f2e-4378-97fb-d30004550d00","name":"categories","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"category_id\": \"1\",\r\n \"category_name\": \"dining\",\r\n {\r\n \"subcategory_id\": \"1001\",\r\n \"subcategory_name\": \"cafes\",\r\n \"subcategory_id\": \"1002\",\r\n \"subcategory_name\": \"pubs\",\r\n ...\r\n }\r\n \"category_id\": \"2\",\r\n \"category_name\": \"retail\",\r\n {\r\n \"subcategory_id\": \"2001\",\r\n \"subcategory_name\": \"electronics\",\r\n \"subcategory_id\": \"2002\",\r\n \"subcategory_name\": \"gifts\",\r\n ...\r\n }\r\n}"}],"_postman_id":"7b074e73-fd62-47fc-87aa-4954cde62fd8"}],"id":"b9f6744e-d1ba-45a7-b4a1-eac3b5bef3ed","description":"This end-point returns the categories present in GMR. The response body will include sub-categories as well if they are present.
\nUse-case: \nThe category/sub-category ids can be used for filtering responses from other end-points such as merchants, offers, affinities, search. The desired ids can be fed as a parameter
\n","_postman_id":"b9f6744e-d1ba-45a7-b4a1-eac3b5bef3ed"},{"name":"Locations","item":[{"name":"countries","id":"a9a1272f-5168-47ce-940b-8beeeb6164cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"This end-point returns the list of countries which are part of GMR. To get the id for a specific country, the 2/3 digit ISO code can be added to the request body
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"a7d7d9d3-55be-4949-aeb3-43d479507643","name":"countries","originalRequest":{"method":"GET","header":[],"url":""},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"country_id\": \"216\",\r\n \"country_name\": \"United States\",\r\n \"country_iso\": US\r\n }\r\n {\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"country_iso\": IN\r\n }\r\n ...\r\n]\r\n\r\n"},{"id":"f4ed9cac-cf6d-41db-9ecd-600e15360831","name":"country search for ISO code","originalRequest":{"method":"GET","header":[],"url":{"raw":"?ISO=UK","query":[{"key":"ISO","value":"UK","description":"standard ISO code for countries","type":"text"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"country_id\": \"200\",\r\n \"country_name\": \"United Kingdom\",\r\n \"country_iso\": UK\r\n }"}],"_postman_id":"a9a1272f-5168-47ce-940b-8beeeb6164cf"},{"name":"cities","id":"b097df97-acc8-4009-bfab-226992e5c0e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"This end-point returns the list of cities for the provided set of country ids. The country ids are fetched from the countries end point. The list of cities can also be queried based on standard ISO country codes.
\n","urlObject":{"query":[{"description":{"content":"country-id from countries end-point
\n","type":"text/plain"},"key":"id","value":"country-id"}],"variable":[]}},"response":[{"id":"30c080d3-39f4-4267-a455-2dfebfc8a09d","name":"cities with iso code","originalRequest":{"method":"GET","header":[],"url":{"raw":"?ISO=IN","query":[{"key":"ISO","value":"IN","description":"iso code of the country"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":" [\r\n {\r\n \"city_id\": \"2800\",\r\n \"name\": \"Chennai, IN\",\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"state_id\": \"30\",\r\n \"state_name\": \"Tamil Nadu\",\r\n \"state_code\": \"TN\"\r\n }\r\n {\r\n \"city_id\": \"2801\",\r\n \"name\": \"Coimbatore, IN\",\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"state_id\": \"30\",\r\n \"state_name\": \"Tamil Nadu\",\r\n \"state_code\": \"TN\"\r\n }\r\n ...\r\n ]"},{"id":"3b7a7be0-6e64-4e71-8cc8-da41bd27c7fb","name":"cities with country-id","originalRequest":{"method":"GET","header":[],"url":{"raw":"?country-id=216","query":[{"key":"country-id","value":"216","description":"country id from countries end point"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"city_id\": \"280\",\r\n \"name\": \"New York City, NY\",\r\n \"country_id\": \"216\",\r\n \"country_name\": \"United States\",\r\n \"state_id\": \"103\",\r\n \"state_name\": \"New York State\",\r\n \"state_code\": \"NY\"\r\n }\r\n {\r\n \"city_id\": \"281\",\r\n \"name\": \"Florida, CA\",\r\n \"country_id\": \"216\",\r\n \"country_name\": \"United States\",\r\n \"state_id\": \"104\",\r\n \"state_name\": \"California\",\r\n \"state_code\": \"CA\"\r\n }\r\n \r\n ...\r\n]\r\n\r\n"}],"_postman_id":"b097df97-acc8-4009-bfab-226992e5c0e6"}],"id":"2c9db2ad-7c61-400c-875a-c82630d670a0","description":"This section contains 2 end-points
\n\n\ncountries - to get countries part of GMR
\n
\n\ncities - to get cities in a given set of countries
\n
Use-case: The location end-points can be used for filtering responses from other end-points such as merchants, offers, affinities, search.
\n","_postman_id":"2c9db2ad-7c61-400c-875a-c82630d670a0"},{"name":"Merchants","item":[{"name":"merchants","id":"84b2fffe-15c9-48ca-88a7-71d7d652b82b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"The merchants end-point takes in category-id or location-id parameters and returns the relevant merchants for the given query parameters. The end-point can also return all merchants in GMR by setting location-id = \"all merchants\" or category_id=\"all merchants\"
\nThe response can be sorted by popularity or ratings and limit can also be set on the number of results
\n","urlObject":{"query":[{"description":{"content":"location identifier fetched from the location end-point
\n","type":"text/plain"},"key":"city-name","value":"chennai"},{"description":{"content":"category identifier fetched from the category end-point
\n","type":"text/plain"},"key":"category-name","value":"dining"},{"description":{"content":"top merchants can be identified by popularity or rating
\n","type":"text/plain"},"key":"sort-by","value":"popularity"},{"description":{"content":"desired sort order
\n","type":"text/plain"},"key":"order-by","value":"desending"},{"description":{"content":"numer of results
\n","type":"text/plain"},"key":"limit","value":"100"}],"variable":[]}},"response":[{"id":"70864057-3d5c-497a-85e4-ad7d494af8bf","name":"merchants in a location","originalRequest":{"method":"GET","header":[],"url":{"raw":"?city-name=chennai&category-name=dining&sort-by=popularity&order-by=descending&limit=100","query":[{"key":"city-name","value":"chennai","description":"location identifier fetched from the location end-point"},{"key":"category-name","value":"dining","description":"category identifier fetched from the category end-point"},{"key":"sort-by","value":"popularity","description":"top merchants can be identified by popularity or rating"},{"key":"order-by","value":"descending","description":"desired sort order"},{"key":"limit","value":"100","description":"number of results"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"merchant_id\": \"abc1235\",\r\n \"merchant_name\": \"Bombay Brasserie\",\r\n \"category\": \"dining\",\r\n \"city_id\": \"2800\",\r\n \"name\": \"Chennai, IN\",\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"state_id\": \"30\",\r\n \"state_name\": \"Tamil Nadu\",\r\n \"state_code\": \"TN\",\r\n \"popularity_score\": \"100\",\r\n \"rating_Score\": \"85\"\r\n }\r\n {\r\n \"merchant_id\": \"abc7865\",\r\n \"merchant_name\": \"The Winchester\",\r\n \"category\": \"dining\",\r\n \"city_id\": \"2800\",\r\n \"name\": \"Chennai, IN\",\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"state_id\": \"30\",\r\n \"state_name\": \"Tamil Nadu\",\r\n \"state_code\": \"TN\",\r\n \"popularity_score\": \"95\",\r\n \"rating_Score\": \"90\" \r\n }\r\n ...\r\n] "}],"_postman_id":"84b2fffe-15c9-48ca-88a7-71d7d652b82b"},{"name":"merchant-details","id":"3b2f4d3e-c878-4157-b107-af7856b55175","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"This end-point returns meta-data details such as address, contact, images, ratings, description, opening hours, price level, accessibility, website, offer availability etc as applicable for different categories
\nThe end-point takes in the merchant-id(s) from merchants end-point as the only parameter
\n","urlObject":{"query":[{"description":{"content":"merchant identifier from the merchants end-point
\n","type":"text/plain"},"key":"merchant-id","value":"abc1235"}],"variable":[]}},"response":[{"id":"e5d50fe7-f0d3-4810-9c70-92ae56839b28","name":"merchant-details","originalRequest":{"method":"GET","header":[],"url":{"raw":"?merchant-id=abc1235","query":[{"key":"merchant-id","value":"abc1235","description":"merchant identifier from the merchants end-point"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"merchant_id\": \"abc1235\",\r\n \"merchant_name\": \"Bombay Brasserie\",\r\n \"category\": \"dining\",\r\n \"city_id\": \"2800\",\r\n \"city_name\": \"Chennai, IN\",\r\n \"country_id\": \"54\",\r\n \"country_name\": \"India\",\r\n \"state_id\": \"30\",\r\n \"state_name\": \"Tamil Nadu\",\r\n \"state_code\": \"TN\",\r\n \"popularity_score\": \"100\",\r\n \"rating_score\": \"85\"\r\n \"sub-category\":\r\n \"region\":\r\n \"sub-region\":\r\n \"address\":\r\n \"phone\":\r\n \"zip_code\":\r\n \"latitude\":\r\n \"longitude\":\r\n \"source_id\":\r\n \"offer_flag\":\r\n \"fulfillment_flag\":\r\n \"tag_flag\":\r\n \"source_name\":\r\n \"image\":\r\n \"url\":\r\n \"price_level\":\r\n \"reviews\":\r\n \"ratings\":\r\n }\r\n]"}],"_postman_id":"3b2f4d3e-c878-4157-b107-af7856b55175"}],"id":"41ddf70e-66ef-48ca-a59d-f0202cba0276","description":"This section contains 2 end-points
\n\n\nmerchants - to get merchant_ids
\n
\n\n","event":[{"listen":"prerequest","script":{"id":"86b5a381-ac4d-4516-9882-8277b3cb3507","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cf2490ad-ab23-4069-9faf-dd76dbce4109","type":"text/javascript","exec":[""]}}],"_postman_id":"41ddf70e-66ef-48ca-a59d-f0202cba0276"},{"name":"Offers","item":[{"name":"offers","id":"6366a25e-7c15-423f-99f7-15b4cb82f8bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"merchant-details - to get merchant meta-data
\n
The offers end-point takes in category-id or location-id parameters and returns the relevant offers for the given query parameters. The end-point can also return all offers in GMR by setting location-id = \"all merchants\" or category_id=\"all merchants\"
\nThe response can be filtered for type of offer - discount, cashback, emi and offer applicability - credit card, debit card, wallet, coupon. A limit can be set on the number of results
\n","urlObject":{"query":[{"description":{"content":"location identifer fetched from locations end-point
\n","type":"text/plain"},"key":"city-name","value":"chennai"},{"description":{"content":"type of offer (discount, cashback, emi)
\n","type":"text/plain"},"key":"offer-type","value":"discount"}],"variable":[]}},"response":[{"id":"e411016c-6846-4069-b125-609726a73d0b","name":"offers","originalRequest":{"method":"GET","header":[],"url":{"raw":"?city-name=chennai&offer-type=discount","query":[{"key":"city-name","value":"chennai","description":"location identifer fetched from locations end-point"},{"key":"offer-type","value":"discount","description":"type of offer (discount, cashback, emi)"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"city_id\": \"2800\",\r\n \"city_name\": \"Chennai, IN\",\r\n \"category\": \"dining\",\r\n \"offer_id\": \"1001\", \r\n \"merchant_id\": \"1088\",\r\n \"merchant_name\": \"Bombay Brasserie\",\r\n \"short_offer_description\": \"15% off on bills above INR 1,000\",\r\n \"offer_type\": \"discount\"\r\n \"available_on\": \"HDFC Credit Cards\"\r\n }\r\n {\r\n \"city_id\": \"2800\",\r\n \"city_name\": \"Chennai, IN\",\r\n \"category\": \"dining\",\r\n \"offer_id\": \"1001\", \r\n \"merchant_id\": \"2088\",\r\n \"merchant_name\": \"The Winchester\",\r\n \"short_offer_description\": \"20% off on food bills with minimum spend of INR 3,000\",\r\n \"offer_type\": \"discount\"\r\n \"available_on\": \"HSBC Credit Cards\"\r\n }\r\n ...\r\n]"}],"_postman_id":"6366a25e-7c15-423f-99f7-15b4cb82f8bc"},{"name":"offer-details","id":"f08cc433-5fd2-47f6-aa3a-f0e36f7a242a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"This end-point returns details about the offers for serving offer details as well as for helping customers decide based on the terms and conditions.
\nThe end-point takes in the offer-id(s) from offers end-point as the only parameter
\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3a5259f8-7a76-46f8-b2f9-e85bc8578d7f","name":"offer-details","originalRequest":{"method":"GET","header":[],"url":{"raw":"?offer-id=1001","query":[{"key":"offer-id","value":"1001","description":"offer identifier from offers end-point"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"city_id\": \"2800\",\r\n \"city_name\": \"Chennai, IN\",\r\n \"category\": \"dining\",\r\n \"offer_id\": \"1001\", \r\n \"merchant_id\": \"1088\",\r\n \"merchant_name\": \"Bombay Brasserie\",\r\n \"short_offer_description\": \"15% off on bills above INR 1,000\",\r\n \"offer_type\": \"discount\",\r\n \"available_on\": \"HDFC Credit Cards\",\r\n \"long_offer_description\":\r\n \"input_offer_id\":\r\n \"offer_redemption_channel\":\r\n \"offer_redemption_url\":\r\n \"offer_valid_from\":\r\n \"offer_valid_to\":\r\n \"offer_image_url\":\r\n \"offer_tnc\":\r\n \"offer_approval_date\":\r\n \"offer_approver_email\":\r\n \"is_online\":\r\n }\r\n ...\r\n]"}],"_postman_id":"f08cc433-5fd2-47f6-aa3a-f0e36f7a242a"}],"id":"a772fda5-cea4-4069-b0ee-5fdaf653a3ce","description":"This section contains 2 end-points
\n\n\noffers - to get offer ids
\n
\n\n","event":[{"listen":"prerequest","script":{"id":"85e85d90-549f-4dd7-a71f-bbb8140bdb96","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b8829da3-cc4b-46e8-a7b8-858b29cf0f2d","type":"text/javascript","exec":[""]}}],"_postman_id":"a772fda5-cea4-4069-b0ee-5fdaf653a3ce"},{"name":"Attributes","item":[{"name":"attributes-for-merchants","id":"27d6701f-e687-4869-a760-e5cf8bed83a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"offer-details - to get offer details
\n
This end-point takes the merchant-id as a parameter and returns the attributes along with scores for attributes
\n","urlObject":{"query":[{"description":{"content":"merchant identifier from merchants end-point
\n","type":"text/plain"},"key":"merchant-id","value":"anc1234"}],"variable":[]}},"response":[{"id":"979ec6e9-a90f-40e0-be23-d52c8c94c2dd","name":"attributes-for-merchants","originalRequest":{"method":"GET","header":[],"url":{"raw":"?merchant-id=anc1234","query":[{"key":"merchant-id","value":"anc1234","description":"merchant identifier from merchants end-point"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"merchant_id\": \"anc1234\",\r\n \"category\": \"dining\",\r\n \"sub-category\": \"cafe\",\r\n \"attributes\":[\r\n \"chinese\": \"0.85\",\r\n \"north indian\": \"0.64\",\r\n \"mid-range\": \"0.67\",\r\n \"serves alcohol\": \"0.12\",\r\n \"full bar\": \"1\",\r\n \"lunch\": \"0.43\",\r\n \"dinner\": \"0.56\",\r\n \"delivery services\": \"0.9\",\r\n \"serves alcohol\": \"1\",\r\n \"full bar\": \"1\",\r\n \"wifi\": \"1\",\r\n \"accepts cards\": \"1\" \r\n ] \r\n }\r\n]"}],"_postman_id":"27d6701f-e687-4869-a760-e5cf8bed83a9"},{"name":"merchants-for-attributes","id":"e783aa34-744c-4bd6-aafc-e93df3ca81bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"This end-point returns the merchants with the highest scores for the attributes provided as a parameter.
\nThe request can take other parameters such as location, minimum score and number of results.
\n","urlObject":{"query":[{"description":{"content":"attributes from the attribute dictionary
\n","type":"text/plain"},"key":"attribute","value":"fine-dining"},{"description":{"content":"location identifier from locations end-point
\n","type":"text/plain"},"key":"city-name","value":"chennai"},{"description":{"content":"minimum attribute score for results
\n","type":"text/plain"},"key":"attribute-score","value":"0.8"},{"description":{"content":"number of results
\n","type":"text/plain"},"key":"limit","value":"100"},{"key":"","value":null}],"variable":[]}},"response":[{"id":"7c5596d5-a1b6-44b4-ba70-d9ff616056a1","name":"merchants-for-attributes","originalRequest":{"method":"GET","header":[],"url":{"raw":"?attribute=fine-dining&city-name=chennai&attribute-score=0.8&limit=100&","query":[{"key":"attribute","value":"fine-dining","description":"attributes from the attribute dictionary "},{"key":"city-name","value":"chennai","description":"location identifier from locations end-point "},{"key":"attribute-score","value":"0.8","description":"minimum attribute score for results "},{"key":"limit","value":"100","description":"number of results "},{"key":"","value":null}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"merchant_id\": \"abc2045\",\r\n \"merchant_name\": \"Little Italy\",\r\n \"city_name\": \"Chennai\",\r\n \"attribute\": \"fine-dining\",\r\n \"attribute_score\": \"0.99\"\r\n }\r\n {\r\n \"merchant_id\": \"abc2065\",\r\n \"merchant_name\": \"Leela\",\r\n \"city_name\": \"Chennai\",\r\n \"attribute\": \"fine-dining\",\r\n \"attribute_score\": \"0.95\"\r\n }\r\n {\r\n \"merchant_id\": \"abc2045\",\r\n \"merchant_name\": \"Savyarasa\",\r\n \"city_name\": \"Chennai\",\r\n \"attribute\": \"fine-dining\",\r\n \"attribute_score\": \"0.85\"\r\n }\r\n ...\r\n]"}],"_postman_id":"e783aa34-744c-4bd6-aafc-e93df3ca81bc"}],"id":"68234602-d9d8-454f-8a2c-a106273a5948","description":"This section contains 2 end-points
\n\n\nattributes-for-merchants - to get attributes for a given set of merchant ids
\n
\n\n","_postman_id":"68234602-d9d8-454f-8a2c-a106273a5948"},{"name":"Affinities","item":[{"name":"connected-merchants","id":"97a23ecf-c6a6-41f2-b655-f4575bf43978","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"authorization"},{"key":"value","value":"merchants-for-attributes - to get merchants for a set of attributes
\n
This end-point returns the merchants with the highest affinities for the attributes provided as a parameter.
\nThe request can take other parameters such as location, category, affinity-value and number of results.
\n","urlObject":{"query":[{"description":{"content":"location identifier from locations end-point
\n","type":"text/plain"},"key":"city-name","value":"chennai"},{"description":{"content":"category identifier from categories end-point
\n","type":"text/plain"},"key":"category-name","value":"dining"},{"description":{"content":"dsitance range from the input merchant
\n","type":"text/plain"},"key":"distance","value":"5"},{"description":{"content":"show results above this cut-off value
\n","type":"text/plain"},"key":"affinity-value","value":"0.7"},{"description":{"content":"number of results
\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[]}},"response":[{"id":"d14461c8-9aec-4dd2-8f55-4ebc442879e4","name":"connected-merchants","originalRequest":{"method":"GET","header":[],"url":{"raw":"?city-name=chennai&category-name=dining&distance=5&affinity-value=0.7&limit=20","query":[{"key":"city-name","value":"chennai","description":"location identifier from locations end-point"},{"key":"category-name","value":"dining","description":"category identifier from categories end-point"},{"key":"distance","value":"5","description":"dsitance range from the input merchant "},{"key":"affinity-value","value":"0.7","description":"show results above this cut-off value"},{"key":"limit","value":"20","description":"number of results "}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"merchant_id\": \"abc1234\",\r\n \"category_name\": \"dining\",\r\n \"city_name\": \"chennai\",\r\n \"distance\": \"0.5 km\",\r\n \"affinity\": \"0.99\"\r\n }\r\n {\r\n \"merchant_id\": \"abc6534\",\r\n \"category_name\": \"dining\",\r\n \"city_name\": \"chennai\",\r\n \"distance\": \"2.5 km\",\r\n \"affinity\": \"0.96\"\r\n }\r\n {\r\n \"merchant_id\": \"xyz1234\",\r\n \"category_name\": \"dining\",\r\n \"city_name\": \"chennai\",\r\n \"distance\": \"1.5 km\",\r\n \"affinity\": \"0.94\"\r\n }\r\n {\r\n \"merchant_id\": \"abc1234\",\r\n \"category_name\": \"dining\",\r\n \"city_name\": \"chennai\",\r\n \"distance\": \"3.0 km\",\r\n \"affinity\": \"0.9\"\r\n }\r\n ...\r\n]"}],"_postman_id":"97a23ecf-c6a6-41f2-b655-f4575bf43978"}],"id":"66245ac5-6fc6-4f93-8e1e-f02c5f06cb0f","description":"This section contains 1 end-point
\n\n\n","_postman_id":"66245ac5-6fc6-4f93-8e1e-f02c5f06cb0f"},{"name":"Trends","item":[{"name":"trending-merchants","id":"12f3d74d-9656-4d04-82cf-5bf1e52dc426","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"12f3d74d-9656-4d04-82cf-5bf1e52dc426"},{"name":"trending-offers","id":"6b5bf11b-2c55-47e7-8aeb-9137874f9086","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"6b5bf11b-2c55-47e7-8aeb-9137874f9086"}],"id":"8ac79434-afeb-434a-9592-2e88c9201756","description":"connected-merchants - to get merchants connected to the input merchant in TasteGraph
\n
find trending mercahnts/offers
\nNot in V1 of the merchant API
\n","_postman_id":"8ac79434-afeb-434a-9592-2e88c9201756"},{"name":"Search","item":[{"name":"matching-merchants","id":"68f1eba1-922d-4d80-9b0f-e17a123690ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"68f1eba1-922d-4d80-9b0f-e17a123690ea"}],"id":"999bf0eb-7852-4293-9fc0-e891a0ef99eb","description":"search for merchants or offers based on names
\nNot in V1 of the merchant API
\n","_postman_id":"999bf0eb-7852-4293-9fc0-e891a0ef99eb"}],"id":"8cebd0af-582d-4573-b4b0-cb4cddb1da2c","description":"","event":[{"listen":"prerequest","script":{"id":"a24ba12e-401f-4d5c-b606-c7fd32ccce3d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"322a3dec-6496-45fb-a6ee-09b8d8b2267f","type":"text/javascript","exec":[""]}}],"_postman_id":"8cebd0af-582d-4573-b4b0-cb4cddb1da2c"}],"event":[{"listen":"prerequest","script":{"id":"5eac4d56-24a7-483f-8d23-0c00efd2323c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2fb4f29f-130f-4271-a0d9-cc52e7038d66","type":"text/javascript","exec":[""]}}]}