updateTaxGroup

Requires permission products:tax:update.

Updates a tax group, including which rates it holds. A code already used by another group is refused. A group that the catalog or the organization's defaults rely on cannot be deactivated or emptied of its active rates. Needs the tax update permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateTaxGroup($input: UpdateTaxGroupInput!) {
  updateTaxGroup(input: $input) {
    id
    code
    name
    createdAt
    calculationMethod
    description
    taxRates {
      id
      createdAt
      taxGroupId
      taxRateId
      updatedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateTaxGroup($input: UpdateTaxGroupInput!) {\n  updateTaxGroup(input: $input) {\n    id\n    code\n    name\n    createdAt\n    calculationMethod\n    description\n    taxRates {\n      id\n      createdAt\n      taxGroupId\n      taxRateId\n      updatedAt\n    }\n  }\n}",
  "variables": {
    "input": {
      "id": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "id": "id"
  }
}

Response:

{
  "data": {
    "updateTaxGroup": {
      "id": "id",
      "code": "string",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "calculationMethod": "string",
      "description": "string",
      "taxRates": [
        {
          "id": "id",
          "createdAt": "2025-01-15T00:00:00Z",
          "taxGroupId": "string",
          "taxRateId": "string",
          "updatedAt": "2025-01-15T00:00:00Z"
        }
      ]
    }
  }
}

updateTaxGroup(
  input: UpdateTaxGroupInput!
): TaxGroup!

Arguments

updateTaxGroup.input ● UpdateTaxGroupInput! non-null input

The ID of the tax group and the fields to change.

Type

TaxGroup object

A set of tax rates applied together.