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!]!
}

Expand ▼

Fields

TaxClass.id ● ID! non-null scalar miscellaneous

The ID of the object.

TaxClass.privateMetadata ● [MetadataItem!]! non-null object miscellaneous

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

TaxClass.privateMetafield ● String scalar miscellaneous

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

Tip: Use GraphQL aliases to fetch multiple keys.

TaxClass.privateMetafield.key ● String! non-null scalar miscellaneous

TaxClass.privateMetafields ● Metadata scalar miscellaneous

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

TaxClass.privateMetafields.keys ● [String!] list scalar miscellaneous

TaxClass.metadata ● [MetadataItem!]! non-null object miscellaneous

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

TaxClass.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

TaxClass.metafield.key ● String! non-null scalar miscellaneous

TaxClass.metafields ● Metadata scalar miscellaneous

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

TaxClass.metafields.keys ● [String!] list scalar miscellaneous

TaxClass.name ● String! non-null scalar miscellaneous

Name of the tax class.

TaxClass.countries ● [TaxClassCountryRate!]! non-null object taxes

Country-specific tax rates for this tax class.

Interfaces

Node interface miscellaneous

An object with an ID

ObjectWithMetadata interface miscellaneous

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