POST
https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}/offers.search
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.
cardholder_idobjectThe triple-defined ID for the entity.
200Offers
400TripleBadRequestError
403TripleNotAuthenticatedError
404TripleInvalidPathError
409TripleIntegrityError
415TripleUnsupportedMediaType
422TripleUnprocessableEntity
500TripleInternalServerError
501TripleNotImplementedError
503TripleServiceUnavailable
curl --request POST \
--url https://api.sandbox.tripleup.dev/partner/card-accounts/{cardholder_id}/offers.search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"page_size": 25,
"proximity_target": {
"radius": 35000
}
}'
Search for offers, optionally by category.
Providing a latitude and longitude for 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.