POST

Query Tax Groups


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 tax groups, given the provided paging, filtering, and sorting.

Only tax groups that were created by this site will be retrieved with this query. Use List Default Tax Groups or List Default Tax Groups By App ID to retrieve a site's default tax groups.

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

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

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/billing/v1/tax-groups/query

Body Params
queryQueryRequired

Query options.

Response Object
taxGroupsArray <TaxGroup>

Retrieved default tax groups.


pagingMetadataPagingMetadata

Paging metadata.

Query TaxGroup

Query tax groups

Request
cURL
curl --location 'https://www.wixapis.com/billing/v1/tax-groups/query' \ --header 'accept: application/json, text/plain, */*' \ --header 'accept-language: en-US,en;q=0.9' \ --header 'authorization: <AUTH>' \ --header 'content-type: application/json' \ --data '{"query":{"cursorPaging":{},"sort":[{"fieldName":"createdDate","order":"DESC"}]}}'
Response
JSON
{ "taxGroups": [ { "id": "c4323faa-ca42-4444-ae1f-d398bcf098a4", "name": "tax group number 1", "revision": "1", "createdDate": "2024-02-05T12:52:21.967Z", "updatedDate": "2024-02-05T12:52:21.967Z" }, { "id": "56ce0f07-adda-4419-9d16-1af86b2ed284", "name": "tax group number 2", "revision": "3", "createdDate": "2024-02-01T14:27:01.462Z", "updatedDate": "2024-02-06T08:46:23.178Z" } ], "pagingMetadata": { "count": 2, "cursors": {}, "hasNext": false } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?