Thanks for being patient while we implement your feedback to improve the developer experience.

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 - string - required

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

example

curl --request GET \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/products/properties' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
  "data": [
    {
      "product_id": 157,
      "tax_properties": {
        "A-123456789": "26",
        "B-6731789": "200"
      }
    }
  ],
  "meta": {}
}

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

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

    Example: 157

  • tax_properties    object

    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

[
  {
    "product_id": 157,
    "tax_properties": {
      "A-123456789": "26",
      "B-6731789": "200"
    }
  }
]

Response

OK

Body

object | application/json

  • data    array[object]

  • meta    object

    Response metadata.

example

{
  "data": [
    {
      "product_id": 157,
      "tax_properties": {
        "A-123456789": "26",
        "B-6731789": "200"
      }
    }
  ],
  "meta": {}
}

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 - string - required

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

example

curl --request DELETE \
  --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/tax/products/properties' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'

Response

No Content