Skip to content

List Tax Categories

Returns a cursor-paginated list of every tax category in the store, newest first. Each tax category is a named group of tax rates that you assign to products to determine how they are taxed.

Operation

OperationTypePurpose
adminSettingsTaxCategoriesQueryCollectionPage through every tax category

Arguments

All arguments are optional and combine in a single query — filter, sort and paginate together.

Pagination

ArgumentDescription
firstNumber of records to return.
afterCursor to fetch the page after (from pageInfo.endCursor).

Filters

Each filter narrows the result; supplying more than one combines with logical AND. They mirror the admin Tax Categories datagrid filters.

ArgumentTypeMatchExample
codeStringPartial (contains)."doc"
nameStringPartial (contains)."Demo"

Sorting

ArgumentTypeValues
sortStringid (default), code, name
orderStringasc, desc (default desc)

Fields

FieldMeaning
_idNumeric tax-category id — use it when referencing a category from other operations.
idThe category's resource path.
codeUnique machine code identifying the category.
nameHuman-readable display name.
descriptionFree-text description.
taxRatesThe attached tax rates connection — detail-only. Has empty edges on the listing (see the note below).
createdAt / updatedAtISO 8601 timestamps.

taxRates is detail-only

The taxRates connection is not loaded on the listing — its edges are empty for every row here to keep the list query light. To read a category's attached rates, fetch the single category with the detail query and select taxRates { edges { node { _id identifier taxRate } } }.

Pass first (page size) and after (an endCursor from a previous page) to paginate. totalCount is the total number of tax categories across all pages.

Released under the MIT License.