Skip to navigation
API Referenceproducts

Create product

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
namestringRequired
descriptionstringOptional
externalIdstringOptional
typeenumOptionalDefaults to product
Allowed values:
activebooleanOptionalDefaults to false
productCodestringOptional
metadatamap from strings to anyOptional

Response

Success response
idstringformat: "uuid"
organizationIdstringformat: "uuid"
namestring
typeenum
The type of product
Allowed values:
activeboolean
externalIdstring or nullOptional
displayIdstringOptional

Human-readable display ID

descriptionstring or nullOptional
productCodestring or nullOptional
ProductAttributelist of objectsOptional
Pricing attributes for this product
metadatamap from strings to any or nullOptional
createdAtdatetimeOptional
updatedAtdatetimeOptional