Creating Tax Code
Endpoint: POST /admin/tax_codes
Purpose
This endpoint allows administrators to create a new tax code, specifying the tax calculation method—either as a flat rate or via an external API. It enables businesses to define and apply region-specific or global tax logic.
Path Parameters
This endpoint does not require any path parameters.
Query Parameters
This endpoint does not require any query parameters.
Use Case
An admin sets up a new tax code to govern how taxes are calculated and applied to orders. This is useful for ensuring tax compliance and customizing rate application across geographies or product types.
Request Body
| Key | Type | Description |
|---|---|---|
| name | String | Name of the tax code. |
| label | String | Label displayed for the tax code, typically user-facing. |
| description | String | Detailed description of the tax code. |
| rate | Number | Tax rate to be applied; could be a fixed value or percentage. |
| resolver_type | String | Method used to apply the tax rate, such as "flat" or "percentage". |
| priority | Number | Determines the order in which the tax is applied if multiple exist. |
| default | Boolean | Indicates if this tax code is the default for the tax profile or category. |
{
"tax_code": {
"name": "TAX_CODE_NAME",
"label": "TAX_LABEL",
"description": "TAX_DESCRIPTION",
"rate": TAX_RATE,
"resolver_type": "RESOLVER_TYPE",
"priority": TAX_PRIORITY,
"default": BOOLEAN
}
}
Response
The response returns the created tax code, showing its internal and display identifiers, calculation method, rate, priority, and default status. This confirms successful setup of the tax rule, ready for use in transactions.
{
"tax_code": {
"id": TAX_CODE_ID,
"name": "TAX_CODE_NAME",
"label": "TAX_LABEL",
"description": "TAX_DESCRIPTION",
"rate": TAX_RATE,
"resolver_type": "RESOLVER_TYPE", // flat or api
"priority": PRIORITY_LEVEL,
"is_default": IS_DEFAULT
}
}
