rewards

Get Offers

Retrieve ALL national and local offer 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 Offers 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/offers

Request

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

Query parameters

pageinteger

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

limitinteger

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

source'NATIONAL' | 'LOCAL'

Source of the merchant associated to the location

Source of merchant associated with offer

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

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

namestring

Name of offer

offerType'INSTORE' | 'ONLINE'

Type of offer (whether it is run online or in-store)

merchantIdstring

Merchant ID in Kard's system

isTargetedboolean

True returns targeted offers, false returns targeted and non-targeted offers

startDateStartstring date-time

Time in string format for offer startDate search (UTC)

startDateEndstring date-time

Time in string format for offer startDate search (UTC)

expirationDateStartstring date-time

Time in string format for offer expirationDate search (UTC)

expirationDateEndstring date-time

Time in string format for offer expirationDate search (UTC)

startDateSort'1' | '-1'

Sort offer start dates chronologically (1 for ascending, -1 for descending)

expirationDateSort'1' | '-1'

Sort offer expiration dates chronologically (1 for ascending, -1 for descending)

merchantNameSort'1' | '-1'

Sort merchant names (1 for A-Z, -1 for Z-A)

Response

Response with status 200

_idstring required

The unique identifier for a document in the database

termsstring required

Terms and conditions on offer

redeemableOnceboolean required

True if offer is redeemable only once, false if not

namestring required

Name of offer

offerType'INSTORE' | 'ONLINE' required

Type of offer (whether it is run online or in-store)

commissionType'FLAT' | 'PERCENT' required

Type of commission on offer (% or a flat $)

startDatestring date-time required

Beginning date of offer (UTC)

expirationDatestring date-time required

Expiration date of offer if applicable (UTC)

isTargetedboolean required

True returns targeted offers, false returns targeted and non-targeted offers

createdDatestring date-time required

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

lastModifiedstring date-time required

Last modified date in Kard's system (UTC)

totalCommissionnumber double required

Offer commission going to issuer and user summed up

isLocationSpecificboolean required

True if offer is valid only for specific locations, false if valid for all locations. Note, this field is usually false

issuersCommissionnumber double

Commission going to the issuer

usersCommissionnumber double

Commission going to user

minTransactionAmountinteger

Minimum Transaction Amount required to redeem offer, if available on offer

maxTransactionAmountinteger

Maximum Transaction Amount allowed to redeem offer, if available on offer

minRewardAmountinteger

Minimum Reward Amount, if available on offer

maxRewardAmountinteger

Maximum Reward Amount, if available on offer

source'NATIONAL' | 'LOCAL' required

Source of the merchant associated to the location

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.