Logo
Get supportSee a Demo
HomeAPI Reference
HomeAPI Reference
    • Authentication
  • API Reference
Get supportSee a Demo
API ReferenceRewardsLocations

Get Locations

Deprecated
GET
/rewards/merchant/locations
GET
/rewards/merchant/locations
1curl -G https://rewards-api.getkard.com/rewards/merchant/locations \
2 -H "Authorization: Bearer <token>" \
3 -d limit=1 \
4 -d page=0
Try it
1[
2 {
3 "_id": "5e27318c9b346f00087fba8l",
4 "address": {
5 "street": "120 Main St",
6 "city": "Philadelphia",
7 "state": "PA",
8 "zipCode": "19147"
9 },
10 "category": "Food & Beverage",
11 "createdDate": "2021-10-05T21:47:11.994Z",
12 "geoLocation": {
13 "longitude": -75.1446869,
14 "latitude": 39.9419429
15 },
16 "lastModified": "2024-05-10T01:38:11.542Z",
17 "locationType": "INSTORE",
18 "merchant": {
19 "_id": "615cc7df498bed0009bbf3bf",
20 "acceptedCards": [
21 "AMERICAN EXPRESS",
22 "MASTERCARD",
23 "VISA"
24 ],
25 "category": "Food & Beverage",
26 "description": "Description of the merchant",
27 "imgUrl": "https://images.somemerchant.com",
28 "name": "Some Merchant",
29 "type": "CARDLINKED",
30 "websiteURL": "http://somemerchant.com",
31 "bannerImgUrl": "https://banner.somemerchant.com"
32 },
33 "merchantId": "615cc7df498bed0009bbf3bf",
34 "name": "Some Location",
35 "offers": [
36 {
37 "_id": "6226427c44bb680009b66b46",
38 "totalCommission": 3.3,
39 "commissionType": "PERCENT",
40 "startDate": "2021-07-04T21:47:12.008Z",
41 "expirationDate": "2026-11-05T00:00:00.000Z",
42 "minTransactionAmount": 5,
43 "maxTransactionAmount": 20,
44 "minRewardAmount": 5,
45 "maxRewardAmount": 20,
46 "issuersCommission": 1.1,
47 "usersCommission": 2.2
48 }
49 ],
50 "phone": "(123) 555-8880",
51 "source": "LOCAL",
52 "googleId": "ChIJUwU6IZrIxokRgX-V0_Y0eXx",
53 "operationHours": {
54 "SUNDAY": "4:00PM - 10:00PM",
55 "MONDAY": "4:30PM - 10:00PM",
56 "TUESDAY": "4:30PM - 10:00PM",
57 "WEDNESDAY": "4:30PM - 10:00PM",
58 "THURSDAY": "4:30PM - 10:00PM",
59 "FRIDAY": "4:30PM - 11:00PM",
60 "SATURDAY": "4:30PM - 11:00PM"
61 }
62 }
63]
Retrieve ALL national and local geographic locations data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use [Get Eligible Locations](/legacy/api/rewards/locations/get-locations-by-user) to build your [map-specific UX experiences](https://github.com/kard-financial/kard-postman#c-discover-clos-near-you-map-view).<br/> <b>Required scopes:</b> `rewards:read`
Was this page helpful?
Previous

Create Attribution Events

Next
Built with
Create Attribution Events

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Query parameters

pageintegerOptional
Page number [>= 0], (default = 0)
limitintegerOptional
Maximum number of locations [1 - 200], (default = 200)
googleIdstringOptional
GoogleId from location
citystringOptional
City of location; <b>REQUIRES</b> state query parameter
zipCodestringOptional
Zip Code of location; <b>CANNOT</b> provide State, City, Longitude, Latitude, or Radius query params when using zipCode
stateenumOptional
State of location; <b>REQUIRES</b> city field
locationNameSortenumOptional
Sort location names (1 for A-Z, -1 for Z-A)
Allowed values:
citySortenumOptional
Sort city names (1 for A-Z, -1 for Z-A)
Allowed values:
stateSortenumOptional
Sort state names (1 for A-Z, -1 for Z-A)
Allowed values:
longitudeintegerOptional
Longitude to search locations from [-180 - 180], <b>REQUIRES</b> latitude field
latitudeintegerOptional
Latitude to search locations from [-90 - 90], <b>REQUIRES</b> longitude field
radiusintegerOptional
Radius to search for locations in miles [1 - 50], (default = 10). <b>REQUIRES</b> longitude & latitude fields
sourceenumOptional
Source of the merchant associated to the location
Allowed values:
categoryenumOptional
Category of merchant associated with location. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
locationNamestringOptional
Name of location
createdDateStartdatetimeOptional
Time in string format for location createdDate search start (UTC)
createdDateEnddatetimeOptional
Time in string format for location createdDate search start (UTC)

Response

This endpoint returns a list of objects.
_idstring
Location ID in Kard's system
addressobject
Address of location
categoryenum
Category of merchant associated with location
createdDatedatetime
Created date of location in Kard's system (UTC)
geoLocationobject
Geo-coordinates of location
lastModifieddatetime
Last modified date of location in Kard's system (UTC)
locationTypeenum
Type of offer associated to location, will always be in INSTORE
Allowed values:
merchantobject
Merchant object associated with location
merchantIdstring
Merchant ID in Kard's system associated to location
namestring
Name of the location
offerslist of objects
Offers associated to the location
phonestring
Phone number for location
sourceenum
Source of the merchant associated to the location
Allowed values:
googleIdstring or null
GoogleId of location
operationHoursobject or null
Hours of operation for location

Errors

GoogleId from location
Source of the merchant associated to the location
Name of location

Bearer authentication of the form Bearer <token>, where token is your auth token.

Retrieve ALL national and local geographic locations data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use Get Eligible Locations to build your map-specific UX experiences.
Required scopes: rewards:read

Geo-coordinates of location

Created date of location in Kard’s system (UTC)

Page number [>= 0], (default = 0)

Last modified date of location in Kard’s system (UTC)

Zip Code of location; CANNOT provide State, City, Longitude, Latitude, or Radius query params when using zipCode

Sort location names (1 for A-Z, -1 for Z-A)

Sort city names (1 for A-Z, -1 for Z-A)

Maximum number of locations [1 - 200], (default = 200)

State of location; REQUIRES city field

City of location; REQUIRES state query parameter

Sort state names (1 for A-Z, -1 for Z-A)

Radius to search for locations in miles [1 - 50], (default = 10). REQUIRES longitude & latitude fields

Latitude to search locations from [-90 - 90], REQUIRES longitude field

Category of merchant associated with location. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

Time in string format for location createdDate search start (UTC)

Longitude to search locations from [-180 - 180], REQUIRES latitude field

Time in string format for location createdDate search start (UTC)