Update Tax Properties | BigCommerce Developer Center

Update one or more tax properties. Only fields specified will be adjusted.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	modify	`store_v2_information`
Information & Settings	read-only	`store_v2_information_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Request

This endpoint expects a list of objects.

idintegerRequired

An internal identifier used by other operations.

codestringOptional

The unique string programmatically references this unique tax property by the tax provider. Merchants should liaise with their tax provider to explore supported values and functions.

display_namestringOptional

The human-readable name for this property. This string will be displayed on the Products screen as a field label.

descriptionstringOptional

Optional. Additional detail about this tax property may help guide merchants. This string will be displayed on the Products screen as a tooltip associated with the relevant field.

Response

datalist of objects

metaobject

Response metadata.

Errors

422

Unprocessable Entity Error

1	using RestSharp;
2
3	var client = new RestClient("https://api.bigcommerce.com/stores/store_hash/v3/tax/properties");
4	var request = new RestRequest(Method.PUT);
5	request.AddHeader("X-Auth-Token", "<apiKey>");
6	request.AddHeader("Content-Type", "application/json");
7	request.AddParameter("application/json", "[\n {\n \"id\": 1\n }\n]", ParameterType.RequestBody);
8	IRestResponse response = client.Execute(request);

1	{
2	"data": [
3	{
4	"id": 1,
5	"code": "A-123456789",
6	"display_name": "Example Tax Property 1",
7	"description": "Food Industry",
8	"created_at": "2022-07-21T19:33:57+00:00",
9	"updated_at": "2022-07-21T19:33:57+00:00",
10	"type": "PRODUCT"
11	}
12	],
13	"meta": {}
14	}