queryBrands( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of up to 100 brands, given the provided filtering, sorting, and cursor paging. Pass supported values to the fields array in the request to include those fields in the response.

Query Brands runs with these defaults, which you can override:

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 100

For field support for filters and sorting, see Brands: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, and Sorting and Paging.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
nameeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read brands in catalog v3
Read v3 catalog
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryBrandsOptions
Returns
Return Type:BrandsQueryBuilder
Was this helpful?
Yes
No