Skip to main content
POST
/
products
Add a new product.
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"
}'
{
  "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"
  },
  "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

Display name for the new product.

Example:

"SunShield Pro UV-Blocking Sunglasses"

​
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"

​
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 length: 1
Example:

"PT-1035"

​
description
string

A brief description of the product.

​
corporation_id
string

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

Example:

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

Response

Create product response.

​
data
object

A product or service provided by the seller.

​
message
string
Example:

"Successfully created product."