Create Material
Creates a new material in the business catalog.
Requires scope: materials:write
Authentication
API_KEYstring
API Key authentication via header
Request
This endpoint expects an object.
name
Display name for the material. Required. Maximum 500 characters.
itemNumber
Item/SKU number. Maximum 255 characters.
brand
Brand name. Maximum 255 characters.
manufacturer
Manufacturer name. Maximum 255 characters.
description
Detailed description of the material.
serialized
Whether units are tracked by serial number. Defaults to false.
categoryNames
Category names to assign to this material. Categories are matched by name.
tagNames
Tag names to assign to this material. Tags are matched or created by name.
Response
This endpoint returns an object.
id
Unique identifier for the material.
name
Display name of the material.
active
Whether the material is currently active in the catalog.
serialized
Whether individual units of this material are tracked by serial number.
categories
List of category names assigned to this material.
createdAt
ISO 8601 timestamp when the record was created.
updatedAt
ISO 8601 timestamp when the record was last updated.
itemNumber
Item/SKU number for the material.
brand
Brand of the material.
manufacturer
Manufacturer of the material.
description
Detailed description of the material.
materialType
Classification of the material.
measurementUnit
Unit of measurement (e.g. EA, FT, LB).
costForBusiness
Internal business cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.
costForClient
Client-facing cost price in USD, taken from the material’s default variation (“Single”/“Standard”), or its oldest variation when no default exists. Null when the material has no variations.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error