Create Material

Beta

POST/v1/catalog/materials

Idempotent with Idempotency-Key header. Learn more

Creates a material.

include[]optional arrayenumValues:itemitem.categoryitem.category.properties

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

skustring

SKU code.

descriptionoptional stringnullable

Description.

notesoptional stringnullable

Notes.

category_idstring

Category ID.

order_pointoptional objectnullable

Order point quantity.

valuestring

Quantity value.

unit_idstring

Unit ID.

lead_timeoptional objectnullable

Lead time quantity.

valuestring

Quantity value.

unit_idstring

Unit ID.

unit_priceoptional objectnullable

Initial unit price. When set, numerator must be a currency unit and denominator must not be.

valuestring (decimal)

Decimal value of the rate.

numerator_unit_idstring

Numerator unit ID.

denominator_unit_idstring

Denominator unit ID.

unit_costoptional objectnullable

Initial unit cost. Same currency rule as unit_price.

valuestring (decimal)

Decimal value of the rate.

numerator_unit_idstring

Numerator unit ID.

denominator_unit_idstring

Denominator unit ID.

attribute_idsoptional array of string

Attribute IDs to connect to the material at creation time.

idstring

Material ID.

objectstringenumValues:material

Resource type identifier.

itemobjectExpandablenullable

Item this material extends.

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code.

descriptionstringnullable

Item description.

notesstringnullable

Notes.

typestringenumValues:productmaterialpart

Item type code.

categoryobjectExpandablenullable

Item category.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:material_categoryproduct_category

Item category type.

ownerobjectnullable

Owner of the item category.

Always returned as null in this endpoint.

propertiesobjectExpandablenullable

Properties associated with this item category.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name.

attributesobjectnullable

Attributes belonging to this property.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

unit_groupobjectExpandablenullable

Unit group associated with this item category. This unit group dictates the available units that items in this category may embody in your production process.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectnullable

Base unit.

Always returned as null in this endpoint.

associated_unitsobjectnullable

Associated units.

Always returned as null in this endpoint.

ownerobjectnullable

Owner.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_valueobjectExpandablenullable

Unit value rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

unit_costobjectExpandablenullable

Unit cost rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

burn_rateobjectExpandablenullable

Burn rate.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Rate value as a decimal string.

numerator_unitobjectnullable

Numerator unit.

Always returned as null in this endpoint.

denominator_unitobjectnullable

Denominator unit.

Always returned as null in this endpoint.

display_valuestring

Human-readable formatted value (e.g. "$25.50 / kg" or "100 kg / hr").

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

attributesobjectExpandablenullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

Attribute value.

colorstringenumValues:bluebrowndefault

Color code.

sort_orderinteger

Display order.

propertyobjectnullable

Property this attribute belongs to (set when the attribute is returned under item.attributes).

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

order_pointobjectnullable

Order point quantity.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectnullable

Associated unit.

lead_timeobjectnullable

Lead time quantity.

idstring

Quantity ID.

objectstringenumValues:quantity

Resource type identifier.

valuestring (decimal)

Decimal value.

display_valuestring

Formatted value with unit abbreviation (e.g. "$1,234.56" or "100 kg").

unitobjectnullable

Associated unit.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Material

Create Material

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const material = await client.catalog.materials.create({
  category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
  sku: 'MAT-001',
});

console.log(material.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const material = await client.catalog.materials.create({
  category_id: 'ic_01ae7bd7bfd21ca0ab81e1357e',
  sku: 'MAT-001',
});

console.log(material.id);

201 example

{
  "id": "ml_014613b8f7959a091d8cc0cef4",
  "object": "material",
  "item": {
    "id": "it_0131e386ac683e8c29a71f6f1f",
    "object": "item",
    "sku": "ALM-2024-1001",
    "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
    "type": "product",
    "category": {
      "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
      "object": "item_category",
      "name": "Electronics",
      "type": "material_category",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_value": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_cost": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "burn_rate": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "attributes": {
      "object": "list",
      "page_info": {
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "at_01c9493ec0c46bb0ed12708ae4",
          "object": "attribute",
          "value": "Premium",
          "color": "red",
          "sort_order": 1,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "order_point": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "lead_time": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ml_014613b8f7959a091d8cc0cef4",
  "object": "material",
  "item": {
    "id": "it_0131e386ac683e8c29a71f6f1f",
    "object": "item",
    "sku": "ALM-2024-1001",
    "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
    "type": "product",
    "category": {
      "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
      "object": "item_category",
      "name": "Electronics",
      "type": "material_category",
      "owner": null,
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_value": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "unit_cost": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "burn_rate": {
      "id": "ra_015aa0a9522cf222024fd21d1a",
      "object": "rate",
      "value": "25.500000000000000000000000000000",
      "numerator_unit": null,
      "denominator_unit": null,
      "display_value": "$25.50 / kg",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    },
    "attributes": {
      "object": "list",
      "page_info": {
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "at_01c9493ec0c46bb0ed12708ae4",
          "object": "attribute",
          "value": "Premium",
          "color": "red",
          "sort_order": 1,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "order_point": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "lead_time": {
    "id": "qty_015a85becc1a6afdfb1afc27ff",
    "object": "quantity",
    "value": "1234.56",
    "display_value": "$1,234.56",
    "unit": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Material

Query Parameters

Request Body

Returns

Responses