Reference Data

Create product

Creates a new product. Custom field values use cf_* keys — see the Custom fields guide.

post/products

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/products
  • Auth: API key in header x-api-key

Request body

namestring required

Product name

type'PRODUCT' | 'SERVICE'

Product type

pricenumber

Product price

descriptionstring nullable

Product description

skustring nullable

SKU code

buyPricenumber nullable

Cost/buy price

isActiveboolean

Whether the product is active

Response

OK

idstring required

Product ID

namestring required

Product name

pricenumber required

Product price

descriptionstring nullable

Product description

skustring nullable

SKU code

typestring required

Product type (PRODUCT or SERVICE)

isActiveboolean required

Whether the product is active

Changes

No recorded changes to this operation across all 1 revision of this API.