API Reference

Searches brands using the same criteria as the GET listing, supplied in the request body.

post
https://platform.routy.app/api/v1/brands/search

Functionally identical to GET /brands but accepts the criteria as a JSON body, which is
convenient for large filter arrays. Paginate with offset/limit.
Requires the CatalogRead policy.

🔐 Required permission: catalog.read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter, sort and pagination criteria.

Filter, sort and pagination criteria for listing catalog brands. All filters are optional and
combined with AND semantics; array filters match any of the supplied values.

id
array of int32s | null

Restrict to these brand ids.

id
programId
array of int32s | null

Restrict to brands associated with any of these affiliate program ids.

programId
verticalId
array of int32s | null

Restrict to brands tagged with any of these vertical ids.

verticalId
status
array of objects | null

Restrict to brands in any of these statuses (New, Enabled, Closed).

status
Allowed:
string | null

Free-text search term (matched against the brand name and related fields).

int32 | null

Maximum number of items to return (page size).

int32 | null

Number of items to skip (0-based offset for pagination).

boolean | null

When true, restrict to brands the calling affiliate has at least one link for.

string | null

Sort expression (column name; may be prefixed to indicate descending order).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago