# Tax Groups

The tax group is used to assign tax rates to products, modifier options, charges, branches, etc.

# The Tax Group Object

# Sample

{
    "taxes": [
        {
            "id": "8d84bebc"
        }
    ],
    "id": "8cd1956b",
    "name": "Imported Goods",
    "name_localized": null,
    "created_at": "2019-02-24 11:43:28",
    "updated_at": "2019-02-24 11:43:28",
    "deleted_at": null
}

# Attributes

Field	Type	Rule	Description
`id`	`string`		Unique identifier for the tax group.
`name*`	`string`	`updatable`	Name of the tax group.
`name_localized`	`string`	`nullable` `updatable`	Localized name of the tax group if business uses localization.
`taxes`	`array`	`nullable` `updatable` `includable`	List of Tax objects attached to the tax group.
`created_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was created.
`updated_at`	`string`	`sortable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was updated.
`deleted_at`	`string`	`nullable`	Time `YYYY-MM-DD HH-MM-SS` in UTC at which the object was deleted.

# List Tax Groups

GET /tax_groups

# Scope

general.read

# Filters

id
name
name_localized
reference
updated_after
is_deleted
created_on
updated_on
deleted_on

# Response

{
  "data": [
    {
      "taxes": [
        {
          "id": "8d84bebc"
        }
      ],
      "id": "8cd1956b",
      "name": "Imported Goods",
      "name_localized": null,
      "created_at": "2019-02-24 11:43:28",
      "updated_at": "2019-02-24 11:43:28",
      "deleted_at": null
    }
  ]
}

# Get Tax Group

GET /tax_groups/{taxGroupId}

# Scope

general.read

# Response

{
    "data": {
        "taxes": [
            {
                "id": "8d84bebc"
            }
        ],
        "id": "8cd1956b",
        "name": "Imported Goods",
        "name_localized": null,
        "created_at": "2019-02-24 11:43:28",
        "updated_at": "2019-02-24 11:43:28",
        "deleted_at": null
    }
}

# Create Tax Group

POST /tax_groups

# Scope

admin.write

# Request

{
    "name": "Adams PLC",
    "name_localized": null,
    "taxes": [
        {
            "id": "8cd1956b"
        }
    ]
}

# Response

{
    "data": {
        "taxes": [
            {
                "id": "8d84bebc"
            }
        ],
        "id": "8cd1956b",
        "name": "Imported Goods",
        "name_localized": null,
        "created_at": "2019-02-24 11:43:28",
        "updated_at": "2019-02-24 11:43:28",
        "deleted_at": null
    }
}

# Update Tax Group

PUT /tax_groups/{taxGroupId}

# Scope

admin.write

# Request

{
    "name": "Adams PLC",
    "name_localized": null,
    "taxes": [
        {
            "id": "8cd1956b"
        }
    ]
}

# Response

{
    "data": {
        "taxes": [
            {
                "id": "8d84bebc"
            }
        ],
        "id": "8cd1956b",
        "name": "Imported Goods",
        "name_localized": null,
        "created_at": "2019-02-24 11:43:28",
        "updated_at": "2019-02-24 11:43:28",
        "deleted_at": null
    }
}

# Delete Tax Group

DELETE /tax_groups/{taxGroupId}

# Scope

admin.write

The API will respond with 200 indicating that the tax group has been deleted.

# Restore Tax Group

PUT /tax_groups/{taxGroupId}/restore

# Scope

admin.restore

The API will respond with 200 indicating that the tax group has been restored.

← Tags Taxes →