queryTaxGroups( )


Developer Preview

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

Creates a query to retrieve a list of tax groups.

The queryTaxGroups() function builds a query to retrieve a list of tax groups and returns a TaxGroupsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining TaxGroupsQueryBuilder functions onto the query. TaxGroupsQueryBuilder functions enable you to sort, filter, and control the results that queryTaxGroups() returns.

queryTaxGroups() runs with the following TaxGroupsQueryBuilder default that you can override:

  • ascending("_id")

The functions that are chained to queryTaxGroups() are applied in the order they are called. For example, if you apply ascending("name") and then ascending("_createdDate"), the results are sorted first by the "name", and then, if there are multiple results with the same "name", the items are sorted by "_createdDate".

The following TaxGroupsQueryBuilder functions are supported for the queryTaxGroups() function. For a full description of the tax group object, see the object returned for the items property in TaxGroupsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),in(),ascending(),descending()
nameeq(),ne(),in(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
Permissions
Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Did this help?