Skip to main content

TaxConfiguration Object

Channel-specific tax configuration.

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!]!
  taxAppId: String
  useWeightedTaxForShipping: Boolean
}

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

channel ● Channel!​

A channel to which the tax configuration applies to.

chargeTaxes ● Boolean!​

Determines whether taxes are charged in the given channel.

taxCalculationStrategy ● TaxCalculationStrategy​

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.

displayGrossPrices ● Boolean!​

Determines whether displayed prices should include taxes.

pricesEnteredWithTax ● Boolean!​

Determines whether prices are entered with the tax included.

countries ● [TaxConfigurationPerCountry!]!​

List of country-specific exceptions in tax configuration.

taxAppId ● String​

The tax app App.identifier that will be used to calculate the taxes for the given channel. Empty value for TAX_APP set as taxCalculationStrategy means that Saleor will iterate over all installed tax apps. If multiple tax apps exist with provided tax app id use the App with newest created date. Will become mandatory in 4.0 for TAX_APP taxCalculationStrategy.

Added in Saleor 3.19

useWeightedTaxForShipping ● Boolean​

Determines whether to use weighted tax for shipping. When set to true, the tax rate for shipping will be calculated based on the weighted average of tax rates from the order or checkout lines.

Added in Saleor 3.21

Interfaces​

Node​

An object with an ID

ObjectWithMetadata​

Returned By​

taxConfiguration query

Member Of​

Channel object ● TaxConfigurationCountableEdge object ● TaxConfigurationUpdate object