Find a Product

Retrieve the details of a specific product

GET /tax/products/{reference_product_id}

cURL

cURL

curl --request GET \
  --url https://api.numeralhq.com/tax/products/{reference_product_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.numeralhq.com/tax/products/{reference_product_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.numeralhq.com/tax/products/{reference_product_id}', 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.numeralhq.com/tax/products/{reference_product_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.numeralhq.com/tax/products/{reference_product_id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.numeralhq.com/tax/products/{reference_product_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.numeralhq.com/tax/products/{reference_product_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "object": "tax.product",
  "reference_product_id": "p-20506",
  "reference_product_name": "Red Shoes",
  "product_category": "CLOTHING_GENERAL",
  "created_at": 1721694425,
  "updated_at": 1721694425,
  "testmode": "true"
}

{
  "error": {
    "error_code": "missing_field",
    "error_message": "Field is required",
    "error_meta": {
      "field": "path.to.fieldname",
      "expected": "string",
      "received": "undefined"
    }
  }
}

Get Product Endpoint (2024-09-01)

Retrieve the details of a specific product using its ID.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

reference_product_id · string · required

The ID of the product to retrieve

Response

200

application/json

Product details

object · string

The type of object: tax.product.

Example:

"tax.product"

reference_product_id · string

The ID of the created product

Example:

"p-20506"

reference_product_name · string

The name of the created product

Example:

"Red Shoes"

product_category · string

The category of the created product

Example:

"CLOTHING_GENERAL"

created_at · number

Epoch datetime representing the date and time the product was created

Example:

1721694425

updated_at · number

Epoch datetime representing the date and time the product was last updated

Example:

1721694425

testmode · boolean

True if using a production API key. False if using a test API key.

Example:

"true"