rewards

Get Locations by Merchant ID

Retrieve all locations associated to a specific Kard merchant ID.<br/> <b>Required scopes:</b> rewards:read

get/rewards/merchant/locations/{merchantId}

Request

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

Path parameters

merchantIdstring required

The Kard merchant ID to query

Query parameters

pageinteger

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

limitinteger

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

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.