POST /products

Creates a product.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
unitLabel String No

Unit label, such as per seat or per unit.

Default value: "unit"

taxCategoryId String No

Tax category of the product. For a complete list of supported tax categories, see TaxJar sales tax API reference. If none of the tax categories from the list are applicable for your product, use the general tax category 00000.

description String No

Description of the product.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

id String No

ID of the product.

_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
name String Yes

Name of the product.

recognition Object No
recognition.creditAccountId String No

ID of the credit journal account.

recognition.debitAccountId String No

ID of the debit journal account.

customFields Object No

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

options[] Array No

Product options such as color, size, and so forth. Product option values are defined in plans. For more information, see Plans.

accountingCode String No

Accounting code of the product.

requiresShipping Boolean No

Specifies if the product requires shipping. If this value is true, shipping calculations are applied.

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.