Get Location by ID

GET

Retrieve location data for a specific Kard location ID.
Required scopes: rewards:read

Path parameters

idstringRequired

The Kard location ID to query

Response

This endpoint returns an object.

_idstring

Location ID in Kard's system

merchantIdstring

Merchant ID in Kard's system associated to location

namestring

Name of the location

locationType"INSTORE"

Allowed values: INSTORE

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

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)

source"NATIONAL" or "LOCAL"

Allowed values: NATIONALLOCAL

Source of the merchant associated to the location

categoryenum

Category of merchant associated with location

operationHoursobjectOptional

Hours of operation for location

googleIdstringOptional

GoogleId of location

Errors

GET

1 curl https://rewards-api.getkard.com/rewards/merchant/location/{id} \
2      -H "Authorization: Bearer <token>"

1 {
2   "_id": "5e27318c9b346f00087fba8l",
3   "merchantId": "615cc7df498bed0009bbf3bf",
4   "name": "Some Location",
5   "locationType": "INSTORE",
6   "address": {
7     "street": "120 Main St",
8     "city": "Philadelphia",
9     "state": "PA",
10     "zipCode": "19147"
11   },
12   "geoLocation": {
13     "longitude": -75.1446869,
14     "latitude": 39.9419429
15   },
16   "phone": "(123) 555-8880",
17   "operationHours": {
18     "MONDAY": "4:30PM - 10:00PM",
19     "TUESDAY": "4:30PM - 10:00PM",
20     "WEDNESDAY": "4:30PM - 10:00PM",
21     "THURSDAY": "4:30PM - 10:00PM",
22     "FRIDAY": "4:30PM - 11:00PM",
23     "SATURDAY": "4:30PM - 11:00PM",
24     "SUNDAY": "4:00PM - 10:00PM"
25   },
26   "googleId": "ChIJUwU6IZrIxokRgX-V0_Y0eXx",
27   "createdDate": "2021-10-05T21:47:11.994Z",
28   "lastModified": "2024-05-10T01:38:11.542Z",
29   "source": "LOCAL",
30   "category": "Food & Beverage"
31 }

Built with

1	curl https://rewards-api.getkard.com/rewards/merchant/location/{id} \
2	-H "Authorization: Bearer <token>"

1	{
2	"_id": "5e27318c9b346f00087fba8l",
3	"merchantId": "615cc7df498bed0009bbf3bf",
4	"name": "Some Location",
5	"locationType": "INSTORE",
6	"address": {
7	"street": "120 Main St",
8	"city": "Philadelphia",
9	"state": "PA",
10	"zipCode": "19147"
11	},
12	"geoLocation": {
13	"longitude": -75.1446869,
14	"latitude": 39.9419429
15	},
16	"phone": "(123) 555-8880",
17	"operationHours": {
18	"MONDAY": "4:30PM - 10:00PM",
19	"TUESDAY": "4:30PM - 10:00PM",
20	"WEDNESDAY": "4:30PM - 10:00PM",
21	"THURSDAY": "4:30PM - 10:00PM",
22	"FRIDAY": "4:30PM - 11:00PM",
23	"SATURDAY": "4:30PM - 11:00PM",
24	"SUNDAY": "4:00PM - 10:00PM"
25	},
26	"googleId": "ChIJUwU6IZrIxokRgX-V0_Y0eXx",
27	"createdDate": "2021-10-05T21:47:11.994Z",
28	"lastModified": "2024-05-10T01:38:11.542Z",
29	"source": "LOCAL",
30	"category": "Food & Beverage"
31	}