Tax Categories

Tax Categories define how products are to be taxed in different countries.

Representations

TaxCategory

TaxCategoryDraft

TaxCategoryDrafts are sent with Create TaxCategory requests.

TaxRate

SubRate beta

A SubRate is used to calculate the taxPortions field in a cart or order. It is useful if the total tax of a country is a combination of multiple taxes (e.g. state and local taxes).

TaxRateDraft

Get TaxCategory

Get TaxCategory by ID

Endpoint: /{projectKey}/tax-categories/{id}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: TaxCategory

Get TaxCategory by Key

Endpoint: /{projectKey}/tax-categories/key={key}
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: TaxCategory

Query TaxCategories

Endpoint: /{projectKey}/tax-categories
Method: GET
OAuth2 Scopes: view_products:{projectKey}
Response Representation: PagedQueryResult with the results array of TaxCategory
Query Parameters:

Create TaxCategory

Endpoint: /{projectKey}/tax-categories
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Request Representation: TaxCategoryDraft
Response Representation: TaxCategory

Update TaxCategory

Update TaxCategory by ID

Endpoint: /{projectKey}/tax-categories/{id}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: TaxCategory
Fields:

Update TaxCategory by Key

Endpoint: /{projectKey}/tax-categories/key={key}
Method: POST
OAuth2 Scopes: manage_products:{projectKey}
Response Representation: TaxCategory
Fields:

Update Actions
Please find below the individual update actions provided on this endpoint.


Change Name

Set Key

Set Description

Add TaxRate

Replace TaxRate

Remove TaxRate

Delete TaxCategory

Delete TaxCategory by ID

Endpoint: /{projectKey}/tax-categories/{id}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey}
Query Parameters:

Delete TaxCategory by Key

Endpoint: /{projectKey}/tax-categories/key={key}
Method: DELETE
OAuth2 Scopes: manage_products:{projectKey}
Query Parameters: