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.
namestringRequired
Display name for the material. Required. Maximum 500 characters.
itemNumberstringOptional

Item/SKU number. Maximum 255 characters.

brandstringOptional
Brand name. Maximum 255 characters.
manufacturerstringOptional
Manufacturer name. Maximum 255 characters.
descriptionstringOptional
Detailed description of the material.
serializedbooleanOptional

Whether units are tracked by serial number. Defaults to false.

categoryNameslist of stringsOptional
Category names to assign to this material. Categories are matched by name.
tagNameslist of stringsOptional
Tag names to assign to this material. Tags are matched or created by name.

Response

This endpoint returns an object.
idUUID
Unique identifier for the material.
namestring
Display name of the material.
activeboolean
Whether the material is currently active in the catalog.
serializedboolean
Whether individual units of this material are tracked by serial number.
categorieslist of strings
List of category names assigned to this material.
tagslist of strings
List of tag names assigned to this material.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.
itemNumberstring

Item/SKU number for the material.

brandstring
Brand of the material.
manufacturerstring
Manufacturer of the material.
descriptionstring
Detailed description of the material.
materialTypeenum
Classification of the material.
measurementUnitstring

Unit of measurement (e.g. EA, FT, LB).

costForBusinessdouble

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.

costForClientdouble

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