Skip to main content
PATCH
/
api
/
v2
/
platform
/
tax_categories
/
{id}
Update a Tax Category
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tax_category: {
      name: 'Clothing',
      is_default: true,
      tax_code: '1257L',
      description: 'Men\'s, women\'s and children\'s branded clothing'
    }
  })
};

fetch('http://{defaultHost}/api/v2/platform/tax_categories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "160",
    "type": "tax_category",
    "attributes": {
      "name": "Clothing",
      "description": "Men's, women's and children's clothing",
      "is_default": true,
      "deleted_at": null,
      "created_at": "2022-11-08T19:35:42.789Z",
      "updated_at": "2022-11-08T19:35:43.019Z",
      "tax_code": "1233K"
    },
    "relationships": {
      "tax_rates": {
        "data": []
      }
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

include
string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Body

application/json
tax_category
object
required

Response

Record updated

data
object
required