Skip to content

List Tax Rates

Returns the store-wide list of tax rates as a cursor-paginated connection. Each node is one tax rate — a rule that defines the tax percentage applied to a location, identified by country/state and either a single zip code or a zip-code range.

Operation

OperationTypePurpose
adminSettingsTaxRates(first: Int, after: String)QueryCollectionList tax rates with cursor pagination

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.

ArgumentTypeMatchExample
identifierStringPartial (contains)."AUDIT"
countryStringExact — two-letter ISO code."US"
stateStringExact."CA"
tax_rate_fromFloatMinimum tax rate (inclusive).5
tax_rate_toFloatMaximum tax rate (inclusive).10

Sorting

ArgumentTypeValues
sortStringid (default), identifier, tax_rate
orderStringasc, desc (default desc)

Fields

FieldMeaning
isZiptrue when the rate targets a zip range (zipFromzipTo); false when it targets a single zipCode.
zipCodeThe single zip code the rate applies to. Populated only when isZip is false.
zipFrom / zipToThe start and end of the zip range. Populated only when isZip is true.
state / countryThe location the rate applies to. country is a two-letter ISO code.
taxRateThe tax percentage (0–100).

For how tax rates fit together with tax categories, see the menu overview.

Released under the MIT License.