Tax Properties
Get Product Tax Properties
GET /stores/{store_hash}/v3/tax/products/properties
Request
Retrieve the tax properties that are associated with one or more products.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- product_id:in in query - arrayrequired
ID of product. To target multiple products, provide a comma-separated list of IDs such as
12,34,56.
example
Response
OK
Body
dataarray[object]
metaobject
Response metadata.
example
Update Product Tax Properties
PUT /stores/{store_hash}/v3/tax/products/properties
Request
Update the tax properties associated with one or more products. This operation will be additive to any tax property values already associated with the product, overwriting any existing tax property values.
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
product_idinteger
requiredA reference to the product that the product tax properties are associated with.
Example: 157
tax_propertiesobject
requiredA simple key-value pairing. The tax property must be defined to associate a value. These values will be sent to the active tax provider during Tax Provider API operations whenever the associated product is included in the operation.
Example: {"A-123456789":"26","B-6731789":"200"}
Example
Response
OK
Body
dataarray[object]
metaobject
Response metadata.
example
Delete Product Tax Properties
DELETE /stores/{store_hash}/v3/tax/products/properties
Request
Delete tax properties that are associated with one or more products.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- product_id:in in query - arrayrequired
ID of product. To target multiple products, provide a comma-separated list of IDs such as
12,34,56.
example
Response
No Content