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
*
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.
crowding_parameters
object
Crowding parameters control the maximum number of consecutive offers
that may share the same characteristic.

**Supported parameters include**:

**- mode:** ONLINE or IN_PERSON

**- category:** RETAIL, FOOD, etc.

**- merchant:** 'ACME inc.', 'Big Multinational Brand', etc.


**NOTE:** Crowding maximums may be exceeded depending on the availability of
relevant replacement offers for any given query. Crowding maximums do not
apply for a particular offer characteristic if a search query filter is applied
to that characterstic. (e.g. Filtering on mode: ONLINE will return exclusively
ONLINE results, even if a crowding parameter for mode is specified.)
page_offset
integer
The beginning index for the current page of offers.
page_size
integer
The number of offers returned for the current page of search results.
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.
text_query
string
Example: italian food
Text query used to search offers. Text queries over 75
characters will be truncated.
RESPONSES
200
Offers
object
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 Recommendations
Get Offer Details by Cardholder