Search Offers

1min
POST
https://api.tripleup.dev/partner/card-accounts/{cardholder_id}/offers.search
triple Prod
Search for offers, optionally by category.
Providing a latitude and longitude for proximity_target is highly
encouraged. Doing so allows Triple to deliver the most relevant Offers
and Merchant Locations.
The default behavior of this endpoint is the null query, which fetches
triple offers recommendations based on a Customer's geo-location,
transaction history, and offer interactions.
However, a Customer can also search directly for offers with ad hoc text
queries and/or by faceting on offer category. This action replaces the
null query with search terms and/or one or more offer category facets.
For example, a Customer may search for 'italian food' in plain text and
select the 'FOOD' offer category facet.
Search results are paginated, using the page_size and page_offset
parameters. For example, page_size=10 and page_offset=30 corresponds to
the 4th page of 10 offers.
Note that Offer Display Rules are enforced against all search results.
Path Parameters
cardholder_id
string
*
Body Parameters
body
object
apply_filter
object
crowding_parameters
object
page_offset
integer
page_size
integer
proximity_target
object
text_query
string
Responses
200
Offers
object
offers
object[]
*
total
number
*
400
TripleBadRequestError
object
status_code
integer
*
content
object
*
403
TripleNotAuthenticatedError
object
status_code
integer
*
content
object
*
404
TripleInvalidPathError
object
status_code
integer
*
content
object
*
409
TripleIntegrityError
object
status_code
integer
*
content
object
*
415
TripleUnsupportedMediaType
object
status_code
integer
*
content
object
*
422
TripleUnprocessableEntity
object
status_code
integer
*
content
object
*
500
TripleInternalServerError
object
status_code
integer
*
content
object
*
501
TripleNotImplementedError
object
status_code
integer
*
content
object
*
503
TripleServiceUnavailable
object
status_code
integer
*
content
object
*
﻿
﻿
Updated 17 Sep 2024
Did this page help you?
Get Offer Recommendations
Get Offer Details by Cardholder