Docs
Management API
Product Tax Properties

Product Tax Properties

Get Product Tax Properties

GET /tax/products/properties

Request

Retrieve the tax properties that are associated with one or more products.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • product_id:in in query - array
    required

    ID of product. To target multiple products, provide a comma-separated list of IDs such as 12,34,56.

    Type: array[integer]

example

Response

OK

Body

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Update Product Tax Properties

PUT /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 header
    required

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required

    The MIME type of the request body.

Body

array | application/json
  • product_id
    integer
    required

    A reference to the product that the product tax properties are associated with.

    Example: 157

  • tax_properties
    object
    required

    A 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

object | application/json
  • data
    array[object]

  • meta
    object

    Response metadata.

example

Delete Product Tax Properties

DELETE /tax/products/properties

Request

Delete tax properties that are associated with one or more products.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • product_id:in in query - array
    required

    ID of product. To target multiple products, provide a comma-separated list of IDs such as 12,34,56.

    Type: array[integer]

example

Response

No Content

Did you find what you were looking for?