Update Part

Beta

PATCH/v1/catalog/parts/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a part. Fields not provided retain their current values.

idstring

Part ID.

include[]optional arrayenumValues:itemitem.categoryitem.unit_value

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

skuoptional string

SKU.

descriptionoptional stringnullable

Description. Send null to clear.

notesoptional stringnullable

Notes. Send null to clear.

idstring

Part ID.

objectstringenumValues:part

Resource type identifier.

itemobjectExpandablenullable

Item.

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.

propertiesobjectnullable

Properties associated with this item category.

Always returned as null in this endpoint.

unit_groupobjectnullable

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.

Always returned as null in this endpoint.

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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Part

Update Part

import Augno from '@augno/sdk';

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

const part = await client.catalog.parts.update('pt_018d7bab53e864351f4c693a21', {
  sku: 'BRG-6204-2RS',
});

console.log(part.id);

import Augno from '@augno/sdk';

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

const part = await client.catalog.parts.update('pt_018d7bab53e864351f4c693a21', {
  sku: 'BRG-6204-2RS',
});

console.log(part.id);

200 example

{
  "id": "pt_018d7bab53e864351f4c693a21",
  "object": "part",
  "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"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "pt_018d7bab53e864351f4c693a21",
  "object": "part",
  "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"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Part

Path Parameters

Query Parameters

Request Body

Returns

Responses