Get Locations by Merchant ID

GET
/rewards/merchant/locations/:merchantId

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

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
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)

sourceenum
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

Built with