API Reference

Searches product categories using the same criteria as the GET listing, in the request body.

post
https://platform.routy.app/api/v1/product-categories/search

Functionally identical to GET /product-categories but accepts the criteria as a JSON body.
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 and pagination criteria.

Filter and pagination criteria for listing product categories. All filters are optional and
combined with AND semantics; array filters match any of the supplied values.

ids
array of int32s | null

Restrict to these product category ids. Sent on the wire as ids.

ids
verticalId
array of int32s | null

Restrict to categories belonging to any of these vertical ids.

verticalId
string | null

Free-text search term (matched against the category 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).

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