Search Retailer

get

https://s3partnerapi-staging.solutran.com/2.2/retailers

You can use this endpoint to search retailers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int64

The unique retailer identifier to filter by.

ProgramId

string

The program identifier.

RetailerName

string

The retailer name to filter by.

MerchantCategory

string

The merchant category classification to filter retailers.

City

string

The city name to filter retailers by location.

State

string

The state code to filter retailers by state location.

PostalCode

string

The postal code to filter retailers by ZIP code location.

Latitude

double

The latitude coordinate for geolocation-based filtering.
Used in conjunction with Longitude and Distance for proximity searches.

Longitude

double

The longitude coordinate for geolocation-based filtering.
Used in conjunction with Latitude and Distance for proximity searches.

Distance

int32

The maximum distance in miles for proximity-based searches.
Requires both Latitude and Longitude to be set for distance calculations.

BannerId

int64

The banner identifier to filter retailers by retail chain or banner group.

PromotionId

int64

The promotion identifier to filter retailers by associated promotion availability.

ClientAccountId

string

The client-specific account identifier to filter retailers by account access.

HouseholdId

string

The household identifier to filter retailers by household-based access.

DefaultSort

string

The default sorting criteria for retailer searches, ordered by retailer name.

SearchCriteria

string

Generates a query string representation of the search criteria.
Only includes parameters that have non-null, non-empty, or non-zero values.

PartnerId

string

Optional partner identifier for the request context.

Include

string

A comma-separated list of related resources to include in the response. Not used for balance inquiry endpoint.

Allowed values for this resource: promotions. Multiple values can be comma-separated.

Path

string

The API endpoint path for the current request.
Used internally for request tracking and logging purposes.

TotalCount

int32

The total number of records available for the search criteria.
May be hidden from serialization based on HideTotals setting.

Size

int32

The actual number of records returned in the current response.

Offset

int32

The starting position (zero-based) for the current page of results.

Limit

int32

The maximum number of records to return per page.
Default value is 100 records.

Sort

string

The sorting criteria for the current request.
Used internally for query processing and not included in JSON serialization.

MoreExist

boolean

Indicates whether more results exist beyond the current page.
Automatically calculated based on TotalCount, Limit, and Offset unless explicitly overridden.

HideTotals

boolean

Controls whether total count information should be hidden from the response.
Used internally for performance optimization when total counts are expensive to calculate.

SummaryData

string

Additional summary data that can be included with the response.
Used for aggregated information or custom metadata specific to the search results.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request