Change Item Category Unit Group

Beta

PUT/v1/catalog/item-categories/{id}/unit-groups/{unit_group_id}

This endpoint is idempotent. Learn more

Changes the unit group of an item category, and with it the units its items can be ordered in.

The new unit group must have the same unit type as the current one — for example, a category measured in mass units can only switch to another mass unit group. System-owned categories cannot be modified.

Permissions requiredValues:item_categories:update

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

idstring

Item category ID.

unit_group_idstring

ID of the unit group to associate with the category.

Must have the same unit type as the category's current unit group; otherwise the request fails with a validation error.

Responses

200

Successful response for Change Item Category Unit Group

Change Item Category Unit Group

import OpenMRP from '@openmrp/sdk';

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

const response = await client.catalog.itemCategories.changeUnitGroup('ug_andst6m79n41', {
  id: 'ic_d06g9c6yc9ck',
});

console.log(response);

import OpenMRP from '@openmrp/sdk';

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

const response = await client.catalog.itemCategories.changeUnitGroup('ug_andst6m79n41', {
  id: 'ic_d06g9c6yc9ck',
});

console.log(response);

200 example

{}

{}

Change Item Category Unit Group

Authorization

Path Parameters

Responses