Get product

Get a product by id.

curl --request GET \
  --url https://base_url/api/v1/products/:id \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
    "name": "SunShield Pro UV-Blocking Sunglasses",
    "tax_code": "TPP",
    "sku": "PT-1035",
    "description": "<string>"
  },
  "message": "Successfully fetched product."
}

GET

products

:id

Get a product by id.

curl --request GET \
  --url https://base_url/api/v1/products/:id \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
    "name": "SunShield Pro UV-Blocking Sunglasses",
    "tax_code": "TPP",
    "sku": "PT-1035",
    "description": "<string>"
  },
  "message": "Successfully fetched product."
}

Authorizations

Authorization

string

header

required

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

Response

Fetch a product response.

data

object

A product or service provided by the seller.

Show child attributes

data.id

string

required

Unique identifier assigned by Commenda for this product.

Example:

"2535af08-a139-4d0c-9827-1651e46dfbcf"

data.corporation_id

string

required

Unique identifier assigned by Commenda for the corporation associated with this product.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

data.name

string

Display name of the product.

Example:

"SunShield Pro UV-Blocking Sunglasses"

data.tax_code

string

default:TPP

Code passed by the caller to determine taxability for this product. Default value, TPP, will be taxable in every jurisdiction. Additional values are available here.

Example:

"TPP"

data.sku

string

A unique stock keeping unit (SKU) identifier for the product. Must be unique within your corporation and contain at least one character.

Minimum string length: 1

Example:

"PT-1035"

data.description

string

Brief description of the product.

message

string

Example:

"Successfully fetched product."

List products Update product

⌘I

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

Authorizations

Response