Create a tax group

Creates a new tax group with name, slug, description, and default status. If marked as default, removes default status from other tax groups.

POST/api/v1/{team_slug}/{app_slug}/tax-groups
API
Management
Updated
Apr 26, 2026

management-api:POST:/api/v1/{team_slug}/{app_slug}/tax-groups

Creates a new tax group with name, slug, description, and default status. If marked as default, removes default status from other tax groups.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/tax-groups
  • Summary: Create a tax group
  • Description: Creates a new tax group with name, slug, description, and default status. If marked as default, removes default status from other tax groups.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters1 parameter
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
Request bodyDocumented body
  • Required: Yes
  • Description: Tax group data
  • Content: application/json (object)

Input Tax Group

PropertyTypeRequiredDetails
descriptionstringNo-
is_defaultbooleanNoIf this tax group is the default tax group. If a product is created without a tax group will this tax group be selected
namestringYes-
slugstringYes-

Generated example (synthetic):

{
  "description": "string",
  "is_default": false,
  "name": "string",
  "slug": "string"
}
Responses4 statuses
StatusDescriptionContent
201Tax group createdapplication/json (object)
400Invalid request (e.g. bad UUID, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

Tax Group Response

PropertyTypeRequiredDetails
dataobjectYes-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanYes-
Tax Group
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
idstringNo-
is_defaultbooleanNo-
marketsobject[]No-
namestringNo-
slugstringNo-
updated_atstringNo-
Tax Group Market
PropertyTypeRequiredDetails
activebooleanNo-
country_codesstring[]No-
country_tax_percentagesobject[]No-
created_atstringNo-
currency_codestringNo-
idstringNo-
localestringNo-
namestringNo-
slugstringNo-
updated_atstringNo-

Generated example (synthetic):

{
  "data": {
    "created_at": "string",
    "description": "string",
    "id": "string",
    "is_default": false,
    "markets": [
      {
        "active": false,
        "country_codes": [],
        "country_tax_percentages": [],
        "created_at": "string",
        "currency_code": "string",
        "id": "string",
        "locale": "string",
        "name": "string",
        "slug": "string",
        "updated_at": "string"
      }
    ],
    "name": "string",
    "slug": "string",
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanYes-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanYes-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanYes-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/tax-groups
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: TaxGroups
  • OpenAPI summary: Create a tax group

Create a tax group

# Create a tax group Creates a new tax group with name, slug, description, and default status. If marked as default, removes default status from other tax groups.
POST /api/v1/{team_slug}/{app_slug}/tax-groups
Purpose

Creates a new tax group with name, slug, description, and default status.

Required inputs

app_slug path

Primary response

201 ยท Tax group created

Operation key

management-api:POST:/api/v1/{team_slug}/{app_slug}/tax-groups

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/tax-groups` - Summary: Create a tax group - Description: Creates a new tax group with name, slug, description, and default status. If marked as default, removes default status from other tax groups. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/tax-groups` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | ## Request body - Required: Yes - Description: Tax group data - Content: application/json (object) ### Input Tax Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `description` | string | No | - | | `is_default` | boolean | No | If this tax group is the default tax group. If a product is created without a tax group will this tax group be selected | | `name` | string | Yes | - | | `slug` | string | Yes | - | **Generated example (synthetic):** ```json { "description": "string", "is_default": false, "name": "string", "slug": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Tax group created | application/json (object) | | 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Tax Group Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | Yes | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | Yes | - | ##### Tax Group | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `id` | string | No | - | | `is_default` | boolean | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `updated_at` | string | No | - | ##### Tax Group Market | Property | Type | Required | Details | | --- | --- | --- | --- | | `active` | boolean | No | - | | `country_codes` | string[] | No | - | | `country_tax_percentages` | object[] | No | - | | `created_at` | string | No | - | | `currency_code` | string | No | - | | `id` | string | No | - | | `locale` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | | `updated_at` | string | No | - | **Generated example (synthetic):** ```json { "data": { "created_at": "string", "description": "string", "id": "string", "is_default": false, "markets": [ { "active": false, "country_codes": [], "country_tax_percentages": [], "created_at": "string", "currency_code": "string", "id": "string", "locale": "string", "name": "string", "slug": "string", "updated_at": "string" } ], "name": "string", "slug": "string", "updated_at": "string" }, "details": [ "string" ], "success": false } ``` ### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | Yes | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | Yes | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | Yes | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/tax-groups` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/tax-groups` - OpenAPI tag: TaxGroups - OpenAPI summary: Create a tax group