Skip to main content
Version: 3.x

TaxConfiguration

Channel-specific tax configuration.

Added in Saleor 3.9
type TaxConfiguration 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
  channel: Channel!
  chargeTaxes: Boolean!
  taxCalculationStrategy: TaxCalculationStrategy
  displayGrossPrices: Boolean!
  pricesEnteredWithTax: Boolean!
  countries: [TaxConfigurationPerCountry!]!
}

Fields​

TaxConfiguration.id ● ID! non-null scalar​

The ID of the object.

TaxConfiguration.privateMetadata ● [MetadataItem!]! non-null object​

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

TaxConfiguration.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
TaxConfiguration.privateMetafield.key ● String! non-null scalar​

TaxConfiguration.privateMetafields ● Metadata scalar​

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

Added in Saleor 3.3
TaxConfiguration.privateMetafields.keys ● [String!] list scalar​

TaxConfiguration.metadata ● [MetadataItem!]! non-null object​

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

TaxConfiguration.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
TaxConfiguration.metafield.key ● String! non-null scalar​

TaxConfiguration.metafields ● Metadata scalar​

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

Added in Saleor 3.3
TaxConfiguration.metafields.keys ● [String!] list scalar​

TaxConfiguration.channel ● Channel! non-null object​

A channel to which the tax configuration applies to.

TaxConfiguration.chargeTaxes ● Boolean! non-null scalar​

Determines whether taxes are charged in the given channel.

TaxConfiguration.taxCalculationStrategy ● TaxCalculationStrategy enum​

The default strategy to use for tax calculation in the given channel. Taxes can be calculated either using user-defined flat rates or with a tax app. Empty value means that no method is selected and taxes are not calculated.

TaxConfiguration.displayGrossPrices ● Boolean! non-null scalar​

Determines whether prices displayed in a storefront should include taxes.

TaxConfiguration.pricesEnteredWithTax ● Boolean! non-null scalar​

Determines whether prices are entered with the tax included.

TaxConfiguration.countries ● [TaxConfigurationPerCountry!]! non-null object​

List of country-specific exceptions in tax configuration.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Returned by​

taxConfiguration query

Member of​

TaxConfigurationCountableEdge object ● TaxConfigurationUpdate object

Was this page helpful?