Change Item Category

Beta

PUT/v1/catalog/items/{id}/category/{category_id}

This endpoint is idempotent. Learn more

Moves an item to a different category and returns the updated item.

The item's rate units (unit value, unit cost, burn rate) and any related order-point, consumption, and production quantity units are switched to the new category's base unit. Only the units change — the numbers attached to them are carried over as they were, so review any figure whose meaning depends on the unit after moving between categories that count differently.

Re-assigning the item's current category succeeds and changes nothing.

Permissions requiredValues:items:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Item ID.

category_idstring

ID of the category to move the item to.

The category's type has to suit the item: a material can only move to a material category, and a product or part can only move to a product category. Anything else fails validation.

The category also has to carry the properties of every attribute the item already has, since the move keeps those attributes. Unlink the offending attributes, or add their properties to the target category, before moving the item.

include[]optional arrayenumValues:categoryunit_valueunit_cost

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

idstring

Item ID.

objectstringenumValues:item

Resource type identifier.

skustring

Stock keeping unit code, unique within the account.

descriptionstringnullable

Item description.

notesstringnullable

Free-form notes about the item.

typestringenumValues:productmaterialpart

What kind of item this is.

product: a finished product.
material: a raw material or component consumed in production.
part: a part used in production.

categoryitem_categoryExpandablenullable

The category this item belongs to.

The category's unit group determines the base unit the item's rates (unit_value, unit_cost, burn_rate) are expressed in.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name of the item category.

notesstringnullable

Free-form notes about the item category.

typestringenumValues:material_categoryproduct_category

What kind of items this category groups.

material_category: groups raw materials and components (items of type material).
product_category: groups finished products and parts (items of type product or part).

An item can only be assigned to a category whose type matches the item's type, and the category's type is fixed at creation.

ownerownernullable

Provenance of the item category.

System-owned categories are platform-provided defaults shared across all accounts and cannot be updated or deleted; account-owned categories are custom to your account.

Always returned as null in this endpoint.

propertieslistExpandablenullable

Properties associated with this item category, such as Color or Size.

These describe the dimensions along which items in the category vary, and are also what the customer-facing catalog shows for the category. Attach and detach them with the Add Item Category Property and Remove Item Category Property endpoints.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of property

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name of the property, such as Color or Size.

Unique within the account.

attributeslistnullable

The selectable values defined under this property.

Listed in the order the attributes are arranged within the property, first to last.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

unit_groupunit_groupExpandablenullable

Unit group associated with this item category.

Items in this category are measured in units belonging to this group, and can only be ordered in those units unless the item's product line defines its own unit group, which takes precedence.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

The dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group, and the dimension is fixed once the group is created.

base_unitunitExpandablenullable

The reference unit designated for this group.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

The dimension this unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

ownerownernullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitslistExpandablenullable

Units associated with this group, each with its own discount and customer portal visibility settings.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of unit_group_unit

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitnullable

The unit this association refers to.

Always returned as null in this endpoint.

discount_percentagenumber

Share of the unit's price removed when an order is placed in this unit.

Expressed as a decimal fraction rather than a whole number, so 0.1 is a 10% discount and 0 is no discount.

discount_fixednumber

Flat amount subtracted from the unit's price when an order is placed in this unit.

Subtracted before discount_percentage is applied.

customer_portal_visibilitystringenumValues:visiblehidden

Whether this unit is shown to customers in the customer portal.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerownernullable

Owner of this resource.

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_valuerateExpandablenullable

Selling value per unit, expressed as a rate (e.g. $25.50 / kg).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

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_costrateExpandablenullable

Cost per unit, expressed as a rate (e.g. $10.00 / kg).

For items a production flow produces, retrieving the item's costs recomputes this from the flow and stores the result here, so it can change without the item having been edited.

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

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_raterateExpandablenullable

Rate at which this item is consumed in production, expressed as a quantity over time (e.g. 100 kg / hr).

idstring

Rate ID.

objectstringenumValues:rate

Resource type identifier.

valuestring (decimal)

Decimal value of the rate, as a string to preserve precision.

Expressed as the amount of the numerator unit per one denominator unit.

numerator_unitunitnullable

Unit of the rate's numerator (e.g. the currency of a price).

Always returned as null in this endpoint.

denominator_unitunitnullable

Unit of the rate's denominator (the per-unit basis, e.g. kilograms for a price per kilogram).

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.

attributeslistExpandablenullable

Attributes assigned to this item.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of attribute

Resources in this page.

idstring

Attribute ID.

objectstringenumValues:attribute

Resource type identifier.

valuestring

The selectable value this attribute represents, such as Red for a Color property or Large for a Size property.

colorstringenumValues:bluebrowndefault

Swatch color used to display this attribute in the UI.

The named colors are arbitrary display choices; default is a neutral fallback used when no specific swatch applies.

sort_orderinteger

Position of this attribute relative to its siblings within the property, starting at 1.

Positions are kept contiguous: creating, reordering, or deleting an attribute automatically shifts its siblings.

propertypropertynullable

The property this attribute belongs to.

Populated only when the attribute is returned under an item's or a volume discount's attributes list.

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.

Responses

200

Successful response for Change Item Category

Change Item Category

import OpenMRP from '@openmrp/sdk';

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

const item = await client.catalog.items.changeCategory('ic_d06g9c6yc9ck', {
  id: 'it_pej07ckhvu62',
});

console.log(item.id);

import OpenMRP from '@openmrp/sdk';

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

const item = await client.catalog.items.changeCategory('ic_d06g9c6yc9ck', {
  id: 'it_pej07ckhvu62',
});

console.log(item.id);

200 example

{
  "id": "it_pej07ckhvu62",
  "object": "item",
  "sku": "ALM-2024-1001",
  "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
  "notes": null,
  "type": "product",
  "category": {
    "id": "ic_d06g9c6yc9ck",
    "object": "item_category",
    "name": "Electronics",
    "notes": "Components and raw materials used across the electronics assembly line.",
    "type": "material_category",
    "owner": null,
    "properties": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "pp_fhnnvtt3q3ov",
          "object": "property",
          "name": "Color",
          "attributes": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "unit_group": {
      "id": "ug_andst6m79n41",
      "object": "unit_group",
      "name": "Weight",
      "notes": "Mass units used for ordering raw materials by weight.",
      "type": "mass",
      "base_unit": {
        "id": "un_82bd37dae5po",
        "object": "unit",
        "name": "Kilogram",
        "abbreviation": "kg",
        "type": "mass",
        "ratio_numerator": "1000",
        "ratio_denominator": "1",
        "offset_numerator": "0",
        "offset_denominator": "1",
        "is_base_unit": false,
        "owner": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "associated_units": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "ugu_sfrqqziz49dw",
            "object": "unit_group_unit",
            "unit": null,
            "discount_percentage": 1,
            "discount_fixed": 0,
            "customer_portal_visibility": "visible",
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        ]
      },
      "owner": null,
      "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"
  },
  "unit_value": {
    "id": "ra_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "at_rf1w295jt5ia",
        "object": "attribute",
        "value": "Premium",
        "color": "red",
        "sort_order": 1,
        "property": null,
        "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": "it_pej07ckhvu62",
  "object": "item",
  "sku": "ALM-2024-1001",
  "description": "6061-T6 aluminum sheet, 4ft x 8ft, 0.125in thick",
  "notes": null,
  "type": "product",
  "category": {
    "id": "ic_d06g9c6yc9ck",
    "object": "item_category",
    "name": "Electronics",
    "notes": "Components and raw materials used across the electronics assembly line.",
    "type": "material_category",
    "owner": null,
    "properties": {
      "object": "list",
      "page_info": {
        "next_page_url": null,
        "previous_page_url": null,
        "has_next_page": false,
        "has_prev_page": false
      },
      "data": [
        {
          "id": "pp_fhnnvtt3q3ov",
          "object": "property",
          "name": "Color",
          "attributes": null,
          "created_at": "2026-05-10T00:00:00Z",
          "updated_at": "2026-05-10T00:23:00Z"
        }
      ]
    },
    "unit_group": {
      "id": "ug_andst6m79n41",
      "object": "unit_group",
      "name": "Weight",
      "notes": "Mass units used for ordering raw materials by weight.",
      "type": "mass",
      "base_unit": {
        "id": "un_82bd37dae5po",
        "object": "unit",
        "name": "Kilogram",
        "abbreviation": "kg",
        "type": "mass",
        "ratio_numerator": "1000",
        "ratio_denominator": "1",
        "offset_numerator": "0",
        "offset_denominator": "1",
        "is_base_unit": false,
        "owner": null,
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      },
      "associated_units": {
        "object": "list",
        "page_info": {
          "next_page_url": null,
          "previous_page_url": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "ugu_sfrqqziz49dw",
            "object": "unit_group_unit",
            "unit": null,
            "discount_percentage": 1,
            "discount_fixed": 0,
            "customer_portal_visibility": "visible",
            "created_at": "2026-05-10T00:00:00Z",
            "updated_at": "2026-05-10T00:23:00Z"
          }
        ]
      },
      "owner": null,
      "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"
  },
  "unit_value": {
    "id": "ra_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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_jhgtyileng4s",
    "object": "rate",
    "value": "25.50",
    "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": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "at_rf1w295jt5ia",
        "object": "attribute",
        "value": "Premium",
        "color": "red",
        "sort_order": 1,
        "property": null,
        "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"
}

Change Item Category

Authorization

Path Parameters

Query Parameters

Returns

Responses