Putting specific tax profiles
Endpoints: PUT /admin/tax_profiles/{id}
Purpose
The PUT /admin/tax_profiles/{id} API is used to update an existing tax profile. It allows administrators to modify the tax profile’s name, description, or its status as the default profile. This ensures the tax settings remain accurate and aligned with evolving business needs.
Path Parameters
/admin/tax_profiles/{id}
| Field | Type | Description |
|---|---|---|
| id | integer | The unique identifier of the categories |
Query Parameters
This endpoint does not have any query parameters.
Use Case
Administrators use this endpoint to update tax profiles when tax rules change or when corrections to existing profiles are required. This is useful for maintaining compliance with tax regulations and ensuring that the correct tax profile is applied across products and categories.
Request Body
The request payload requires at least one of the following fields to update: name, description or default. The tax profile is identified by the {id} path parameter.
{
"tax_profile": {
"name": "UPDATED_TAX_PROFILE_NAME",
"description": "UPDATED_TAX_PROFILE_DESCRIPTION",
"default": IS_DEFAULT
}
}
Response
The response returns the updated tax profile with the modified fields along with the original ID and updated timestamps.
{
"tax_profile": {
"id": TAX_PROFILE_ID,
"name": "UPDATED_TAX_PROFILE_NAME",
"description": "UPDATED_TAX_PROFILE_DESCRIPTION",
"default": IS_DEFAULT,
"created_at": "CREATED_TIMESTAMP",
"updated_at": "UPDATED_TIMESTAMP"
}
}