Retrieve national and local geographic locations data that a specified user has eligible in-store offers at. To include local merchant locations, include the includeLocal query parameter. Call this endpoint to build out your targeted offers and map-specific UX experiences. Please note that Longitude and Latitude fields are prioritized over State, City and Zipcode.
Required scopes: rewards:read
Referring partner user ID from issuer that specifies user
Page number [>= 0], (default = 0)
Maximum number of locations to be returned [1 - 200], (default = 200)
Sort location names (1 for A-Z, -1 for Z-A)
Sort city names (1 for A-Z, -1 for Z-A)
Sort state names (1 for A-Z, -1 for Z-A)
Name of location
City of location; REQUIRES state query parameter
Zip Code of location; CANNOT provide State, City, Longitude, Latitude, or Radius query params when using zipCode
State of location; REQUIRES city field
GoogleId from location
Source of the merchant associated to the location
Category of merchant associated with location. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)
Longitude to search locations from [-180 - 180], REQUIRES latitude field
Latitude to search locations from [-90 - 90], REQUIRES longitude field
Radius to search for locations in miles [1 - 50], (default = 10). REQUIRES longitude & latitude fields
When included, the response will include local merchant locations alongside national merchant locations. If omitted, the response will only contain national merchant locations.
Time in string format for location createdDate search start (UTC)
Time in string format for location createdDate search end (UTC)
Location ID in Kard’s system
Address of location
Category of merchant associated with location
Created date of location in Kard’s system (UTC)
Geo-coordinates of location
Last modified date of location in Kard’s system (UTC)
Type of offer associated to location, will always be in INSTORE
Merchant object associated with location
Merchant ID in Kard’s system associated to location
Name of the location
Offers associated to the location
Phone number for location
Source of the merchant associated to the location
GoogleId of location
Hours of operation for location