Search

Search brand locations

Returns a paginated list of brand locations matching the search criteria. Deprecated: use the Reporting API /brands/locations endpoint instead.

post/api/search/smart/brands/locations

Request

Request body

located_in_marketstring

Comma-separated located-in market IDs.

marketstring

Comma-separated target market IDs.

leaguestring

Comma-separated league IDs.

brandstring

Comma-separated brand IDs.

citystring

Comma-separated city IDs.

categorystring

Comma-separated category IDs.

subcategorystring

Comma-separated subcategory IDs.

statestring

Comma-separated state IDs.

order_by'brand' | 'category' | 'subcategory' | 'street' | 'city' | 'state' | 'country' | 'total_deals_count'

Field to order results by.

order_direction'asc' | 'desc'

Sort direction.

pageinteger

Page number.

per_pageinteger

Number of items per page.

Response

A paginated list of brand locations.

Changes

No recorded changes to this operation across all 2 revisions of this API.