Get Offer Recommendations

1min
POST
https://api.tripleup.dev/partner/card-accounts/{cardholder_id}/offers.recommendations
triple Prod
Get Offer Recommendations.
Get Offer Recommendations, optionally filtering by offer modes and/or offer categories.
If include_modes and include_categories are omitted, specified as null or specified
as an empty list, the application will default to include all values in the enum.
Providing a latitude and longitude for proximity_target is highly
encouraged. Doing so allows Triple to deliver the most relevant Offers
and Merchant Locations.
Note that Offer Display Exclusion Rules are enforced against all recommendations.
PATH PARAMETERS
cardholder_id
string
*
Example: triple-abc-123
The triple-defined ID for the entity.
BODY PARAMETERS
body
object
apply_filter
object
Applies a search filter.

If more than one filter property is specified, the filter condition
is expressed as an AND of the specified filter properties.
include_categories
string[]
include_modes
string[]
proximity_target
object
The Geo-coordinates for the end-user's location,
given as `latitude` and `longitude` values or as approximate location
parameters.

If providing postal_code, country_code is required and must be set to US,
as only US ZIP codes are currently supported.

If providing `latitude` and `longitude`, both fields must be set.

If no location is provided, the default postal code for the Card Account or
Card Program is used.
page_size
integer
RESPONSES
200
Recommended Offers
object
recommended_offers
object[]
*
total
number
*
The total number of offers available for the given query.
400
TripleBadRequestError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
403
TripleNotAuthenticatedError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
404
TripleInvalidPathError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
409
TripleIntegrityError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
415
TripleUnsupportedMediaType
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
422
TripleUnprocessableEntity
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
500
TripleInternalServerError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
501
TripleNotImplementedError
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
503
TripleServiceUnavailable
object
status_code
integer
*
The 3-digit HTTP Response Status code
content
object
*
The error response content.
﻿
﻿
Updated 24 Oct 2023
Did this page help you?
Get Offer Categories
Search Offers