rewards

Get Locations

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.<br/> <b>Required scopes:</b> rewards:read

get/rewards/merchant/locations

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/rewards/merchant/locations
  • Auth: HTTP bearer

Query parameters

pageinteger

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

limitinteger

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

googleIdstring

GoogleId from location

citystring

City of location; <b>REQUIRES</b> state query parameter

zipCodestring

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

state'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FM' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MH' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PW' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VI' | 'VA' | 'WA' | 'WV' | 'WI' | 'WY'

State of location; <b>REQUIRES</b> city field

locationNameSort'1' | '-1'

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

citySort'1' | '-1'

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

stateSort'1' | '-1'

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

longitudeinteger

Longitude to search locations from [-180 - 180], <b>REQUIRES</b> latitude field

latitudeinteger

Latitude to search locations from [-90 - 90], <b>REQUIRES</b> longitude field

radiusinteger

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

source'NATIONAL' | 'LOCAL'

Source of the merchant associated to the location

category'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel'

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

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

locationNamestring

Name of location

createdDateStartstring date-time

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

createdDateEndstring date-time

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

Response

Response with status 200

_idstring required

The unique identifier for a document in the database

merchantIdstring required

Merchant ID in Kard's system associated to location

namestring required

Name of the location

locationType'INSTORE' required
phonestring required

Phone number for location

googleIdstring

GoogleId of location

createdDatestring date-time required

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

lastModifiedstring date-time required

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

source'NATIONAL' | 'LOCAL' required

Source of the merchant associated to the location

category'Arts & Entertainment' | 'Baby, Kids & Toys' | 'Books & Digital Media' | 'Clothing, Shoes & Accessories' | 'Computers, Electronics & Software' | 'Convenience' | 'Gas' | 'Department Stores' | 'Food & Beverage' | 'Health & Beauty' | 'Home & Garden' | 'Miscellaneous' | 'Occasions & Gifts' | 'Pets' | 'Sports & Outdoors' | 'Supplies & Services' | 'Travel' required

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

Changes

No recorded changes to this operation across all 1 revision of this API.