rewards

Get Merchants

Retrieve ALL national and local merchant data regardless of whether a user is eligible to see them. This endpoint is a legacy endpoint and will no longer be maintained soon. Instead, use Get Eligible Merchants to retrieve national merchant data and build your targeted offers UX experience. Local merchants and offers details can be found by calling the Get Eligible Locations endpoint with the includeLocal query parameter.<br/> <b>Required scopes:</b> rewards:read

get/rewards/merchant

Request

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

Query parameters

pageinteger

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

limitinteger

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

source'NATIONAL' | 'LOCAL'

Source of the merchant associated to the location

Merchant source

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'

Category of merchant. Please use URL Encode for non single word categories. (Food & Beverage should be Food%20%26%20Beverage)

Response

Response with status 200

_idstring required

The unique identifier for a document in the database

namestring required

Merchant name

descriptionstring required

Merchant description - usually a blurb outlining more details about the merchant

websiteURLstring required

Merchant's URL website

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)

acceptedCardsCommonsAcceptedCards[] required
source'NATIONAL' | 'LOCAL' required

Source of the merchant associated to the location

createdDatestring date-time required

Created date of merchant in Kard's system (UTC)

lastModifiedstring date-time required

Last modified date of merchant in Kard's system (UTC)

imgUrlstring required

Merchant image asset URL

bannerImgUrlstring

Merchant banner image asset URL

Changes

No recorded changes to this operation across all 1 revision of this API.