Skip to main content

Query brands.

POST 
/brands/query

Query brands using filters, sorting, and pagination. Brands represent manufacturers or labels associated with products.

Filter​

The filter object must have exactly one key. It can be:

  • A property filter, such as search (a string, to search for in brand name), id or in (an integer or array of integers, that represent brand IDs), assignable (boolean, brands assignable to your organization), deleted (boolean, include/exclude soft-deleted brands).
  • A compound filter with key and (array of filter objects; all must match), or (array of filter objects; at least one must match), or not (single filter object to negate).

Sort​

Sort by one of: id, name, product_count.

Page​

Size must be one of: 10, 50, 100, 250.

Query parameter​

Use viewableOnly=true to restrict results to brands the authenticated user is allowed to view (e.g. brands of their organization).

Request​

Responses​

Successful operation. Returns a paginated list of brands.