Tax Properties
Include tax properties and product tax properties in tax calculations.
Get Tax Properties
GET /stores/{store_hash}/v3/tax/properties
Request
Retrieve all tax properties defined in this store.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- id:in in query - array
ID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as
12,34,56
.
example
Response
OK
Body
dataarray[object]
metaobject
Response metadata.
example
Update Tax Properties
PUT /stores/{store_hash}/v3/tax/properties
Request
Update one or more tax properties. Only fields specified will be adjusted.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
idinteger
requiredAn internal identifier used by other operations.
Example: 1
codestring
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-123456789
display_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 1
descriptionstring
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
dataarray[object]
metaobject
Response metadata.
example
Create Tax Properties
POST /stores/{store_hash}/v3/tax/properties
Request
Create one or more tax properties. A code and a display name must be included when creating tax properties.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
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-123456789
display_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 1
descriptionstring
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
dataarray[object]
metaobject
Response metadata.
example
Delete Tax Properties
DELETE /stores/{store_hash}/v3/tax/properties
Request
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 headerrequired
Parameters
- store_hash in path - string
- id:in in query - arrayrequired
ID of tax property. To target multiple tax properties, provide a comma-separated list of IDs such as
12,34,56
.
example
Response
No Content