POST
/
products
curl --request POST \
  --url https://base_url/api/v1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "SunShield Pro UV-Blocking Sunglasses",
  "tax_code": "TPP",
  "sku": "PT-1035",
  "description": "<string>",
  "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
  "customs_jurisdiction_details": {
    "US": "4905.90.20.00"
  },
  "weight_in_kg": 3.5,
  "volume_in_liters": 3.5
}'
{
  "data": {
    "id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
    "name": "SunShield Pro UV-Blocking Sunglasses",
    "tax_code": "TPP",
    "sku": "PT-1035",
    "description": "<string>",
    "corporation_id": "b6d009b0-d174-463f-b030-94643c28e209",
    "customs_jurisdiction_details": {
      "US": "4905.90.20.00"
    },
    "weight_in_kg": 3.5,
    "volume_in_liters": 3.5,
    "created_at": 1727284490
  },
  "message": "Successfully created product."
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

The name of the product.

Example:

"SunShield Pro UV-Blocking Sunglasses"

sku
string
required

The unique identifier for this product. It should be unique across the corporation.

Example:

"PT-1035"

corporation_id
string
required

The unique identifier for the corporation associated.

Example:

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

tax_code
enum<string>

Tax code to define how a product should be charged for sales tax. (More options coming soon).

Available options:
TPP
description
string

A one line description about the product.

customs_jurisdiction_details
object

A mapping of ISO 3166 country codes to their respective Harmonized System (HS) codes for customs classification.

Example:
{ "US": "4905.90.20.00" }
weight_in_kg
number

The weight of the product in kilograms.

Example:

3.5

volume_in_liters
number

The volume of the product in liters.

Example:

3.5

Response

200
application/json
Create product response.
data
object
message
string
Example:

"Successfully created product."