Taxes > Tax Rules > taxRulesModify
Commerce APITaxesTax RulestaxRulesModify
taxRulesModify
POST:tax_rules.json

Description

Modify one or multiple tax rules.

Permission bit: "tax_rules.modify"

Topic: Tax Rules

Arguments

data: [TaxRuleModify!]!

Main argument for mutations.


ids: [String!]!

List of tax rule ids. See also: Unique Identifiers

Example: ["tr_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

components: String

Tax rule components (custom JSON format)

Example: "[]"


name: String

Name of the tax rule

Example: "New York Local Tax"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


priority: Int

Priority of the rule (rule with higher priority is to be evaluated first)

Example: 0


zones: [ZoneCreate!]


Result

[TaxRule!]

Preview (typescript)

Loading module