Get Locations by Merchant ID

curl -G https://rewards-api.getkard.com/rewards/merchant/locations/%7BmerchantId%7D \
     -H "Authorization: Bearer <token>" \
     -d limit=1 \
     -d page=0

[
  {
    "_id": "5e27318c9b346f00087fba8l",
    "merchantId": "615cc7df498bed0009bbf3bf",
    "name": "Some Location",
    "locationType": "INSTORE",
    "address": {
      "street": "120 Main St",
      "city": "Philadelphia",
      "state": "PA",
      "zipCode": "19147"
    },
    "geoLocation": {
      "longitude": -75.1446869,
      "latitude": 39.9419429
    },
    "phone": "(123) 555-8880",
    "createdDate": "2021-10-05T21:47:11.994Z",
    "lastModified": "2024-05-10T01:38:11.542Z",
    "source": "LOCAL",
    "category": "Food & Beverage",
    "operationHours": {
      "SUNDAY": "4:00PM - 10:00PM",
      "MONDAY": "4:30PM - 10:00PM",
      "TUESDAY": "4:30PM - 10:00PM",
      "WEDNESDAY": "4:30PM - 10:00PM",
      "THURSDAY": "4:30PM - 10:00PM",
      "FRIDAY": "4:30PM - 11:00PM",
      "SATURDAY": "4:30PM - 11:00PM"
    },
    "googleId": "ChIJUwU6IZrIxokRgX-V0_Y0eXx"
  }
]

Retrieve all locations associated to a specific Kard merchant ID.
Required scopes: rewards:read

Authentication

AuthorizationBearer

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

Path parameters

merchantIdstringRequired

The Kard merchant ID to query

Query parameters

pageintegerOptional

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

limitintegerOptional

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

Response

This endpoint returns a list of objects.

_idstring

Location ID in Kard's system

merchantIdstring

Merchant ID in Kard's system associated to location

namestring

Name of the location

locationTypeenum

Type of offer associated to location, will always be in INSTORE

Allowed values:

addressobject

Address of location

geoLocationobject

Geo-coordinates of location

phonestring

Phone number for location

createdDatedatetime

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

lastModifieddatetime

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

sourceenum

Source of the merchant associated to the location

Allowed values:

categoryenum

Category of merchant associated with location

operationHoursobject

Hours of operation for location

googleIdstring

GoogleId of location

Errors

400

Invalid Request

401

Unauthorized Error

500

Internal Server Error