Skip to main content
View Markdown

TaxClass Object

Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates.

type TaxClass implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  name: String!
  countries: [TaxClassCountryRate!]!
}

Fields​

id ● ID!​

The ID of the object.

privateMetadata ● [MetadataItem!]!​

List of private metadata items. Requires staff permissions to access.

privateMetafield ● String​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

privateMetafields ● Metadata​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

metadata ● [MetadataItem!]!​

List of public metadata items. Can be accessed without permissions.

metafield ● String​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key ● String!​

metafields ● Metadata​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys ● [String!]​

name ● String!​

Name of the tax class.

countries ● [TaxClassCountryRate!]!​

Country-specific tax rates for this tax class.

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Returned By​

taxClass query

Member Of​

Order object ● OrderLine object ● Product object ● ProductType object ● ShippingMethodType object ● TaxClassCountableEdge object ● TaxClassCountryRate object ● TaxClassCreate object ● TaxClassDelete object ● TaxClassUpdate object