Tax Properties
Include tax properties and product tax properties in tax calculations.
Get Tax Properties
GET https://api.bigcommerce.com/stores/{store_hash}/v3/tax/propertiesRequest
Retrieve all tax properties defined in this store.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id:in in query - arrayID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as
12,34,56.Type: array[integer]
example
Response
OK
Body
object | application/json
dataarray[object]
example
Update Tax Properties
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/tax/propertiesRequest
Update one or more tax properties. Only fields specified will be adjusted.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
array | application/json
idinteger
requiredAn internal identifier used by other operations.Example: 1codestring
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.Example: A-123456789display_namestring
The human-readable name for this property. This string will be displayed on the Products screen as a field label.Example: Example Tax Property 1descriptionstring
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.Example: Food Industry
example
Response
OK
Body
object | application/json
dataarray[object]
example
Create Tax Properties
POST https://api.bigcommerce.com/stores/{store_hash}/v3/tax/propertiesRequest
Create one or more tax properties. A code and a display name must be included when creating tax properties.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
array | application/json
codestring
requiredThe 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.Example: A-123456789display_namestring
requiredThe human-readable name for this property. This string will be displayed on the Products screen as a field label.Example: Example Tax Property 1descriptionstring
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.Example: Food Industry
example
Response
OK
Body
object | application/json
dataarray[object]
example
Delete Tax Properties
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/tax/propertiesRequest
Delete one or multiple tax properties. A tax property must have zero usages within product tax properties before you can delete it.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- id:in in query - arrayrequiredID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as
12,34,56.Type: array[integer]
example
Response
No Content
See something you can improve? Edit this file on GitHub
Did you find what you were looking for?