API ReferenceRewardsLocations

Get Location by ID

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

Path parameters

idstringRequired
The Kard location ID to query

Headers

AuthorizationstringRequired

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

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
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 or null
Hours of operation for location
googleIdstring or null
GoogleId of location

Errors