Product Tax Codes (PTC) & Attributes

List Product Attributes

Returns the attributes you can apply to your products, sorted alphabetically by code. An attribute rides on a product tax code as a trailing component (a rented computer is TANGIBLE_PERSONAL_PROPERTY._RENTAL) and can change how a product is taxed. Each attribute carries its group; attributes sharing a group may be mutually exclusive. Pass ptc to narrow the list to the attributes worth offering on that code. The default page holds up to 1000 attributes — enough to return the whole list in one call today. To page, pass starting_after set to the code of the last item you received; has_more is true while more attributes remain. Each page carries a strong ETag; send it back as If-None-Match to get 304 Not Modified when that page has not changed.

GET

product-attributes

curl --request GET \
  --url https://api.taxwire.com/product-attributes \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.taxwire.com/product-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taxwire.com/product-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taxwire.com/product-attributes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taxwire.com/product-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "object": "list",
  "url": "/product-attributes",
  "data": [
    {
      "code": "_RENTAL",
      "name": "Rental",
      "description": "The product is rented to the buyer rather than sold.",
      "group": {
        "key": "vehicle_title",
        "name": "Motor vehicle title",
        "mutually_exclusive": true
      },
      "ptcs": [
        "TANGIBLE_PERSONAL_PROPERTY",
        "DIGITAL_PROPERTY"
      ]
    }
  ]
}

{
  "errors": [
    {
      "status": "422",
      "code": "validation_required_field",
      "title": "Missing quantity",
      "detail": "Please provide a value for the required quantity field",
      "source": {
        "pointer": "/data/attributes/line_items/0/quantity"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "429",
      "code": "rate_limit_error",
      "title": "Too Many Requests",
      "detail": "Rate limit exceeded"
    }
  ]
}

{
  "errors": [
    {
      "status": "500",
      "code": "system_internal_error",
      "title": "Internal Error",
      "detail": "An unexpected error occurred. Our team has been notified."
    }
  ]
}

See how to use it with code examples here!

Authorizations

X-API-Key

string

header

required

Query Parameters

ptc

string | null

Narrow the list to the attributes worth offering on this product tax code, applying Taxwire's applicability rules. Omit it for the whole vocabulary.

Example:

"TANGIBLE_PERSONAL_PROPERTY.CLOTHING"

limit

integer

default:1000

Page size, between 1 and 1000. Defaults to 1000.

Required range: 1 <= x <= 1000

starting_after

string | null

Return attributes after this one. Pass the code of the last item from the previous page to fetch the next page.

Response

Successful Response

List envelope for GET /product-attributes, cursor-paged by code.

has_more

boolean

required

More results available

Examples:

true

false

object

string

default:list

url

string

default:/product-attributes

data

ProductAttributeItem · object[]

A page of the attributes you can assign to your products.

Show child attributes

List Product Attributes

curl --request GET \
  --url https://api.taxwire.com/product-attributes \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.taxwire.com/product-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taxwire.com/product-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taxwire.com/product-attributes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taxwire.com/product-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "object": "list",
  "url": "/product-attributes",
  "data": [
    {
      "code": "_RENTAL",
      "name": "Rental",
      "description": "The product is rented to the buyer rather than sold.",
      "group": {
        "key": "vehicle_title",
        "name": "Motor vehicle title",
        "mutually_exclusive": true
      },
      "ptcs": [
        "TANGIBLE_PERSONAL_PROPERTY",
        "DIGITAL_PROPERTY"
      ]
    }
  ]
}

{
  "errors": [
    {
      "status": "422",
      "code": "validation_required_field",
      "title": "Missing quantity",
      "detail": "Please provide a value for the required quantity field",
      "source": {
        "pointer": "/data/attributes/line_items/0/quantity"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "429",
      "code": "rate_limit_error",
      "title": "Too Many Requests",
      "detail": "Rate limit exceeded"
    }
  ]
}

{
  "errors": [
    {
      "status": "500",
      "code": "system_internal_error",
      "title": "Internal Error",
      "detail": "An unexpected error occurred. Our team has been notified."
    }
  ]
}

Getting Started

Guides

API details

Calculations

Transactions

Customers

Product Tax Codes (PTC) & Attributes

Products

Resources

List Product Attributes

Authorizations

Query Parameters

Response