Update an item category

Operation ID: updateItemCategory

Group: Inventory › Item Categories

Open in the interactive reference

PATCH /inventory/item-categories/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates an item category with the fields you send. A field you leave out keeps its current value. To clear parentId and make this a top-level category, send null.

You can change the category's name, description, active flag, turnover target, and parent.

The response is only the id. To see the updated category, use GET inventory/item-categories/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the item category you want to update.

Request body

Required, application/json: updateItemCategoryInput.

Field Type Required Description
name string no The new display name of the category, for example 'Hardware'. Cannot be cleared, and is not checked for uniqueness: renaming onto a name another category already has is allowed.
description string no A new free-form description of what the category covers.
active boolean no Whether the category can be chosen on new items. Set false to retire the category without deleting it: existing items keep their assignment and new ones cannot choose it.
idealTurnoverRatio decimal no A new target inventory turnover for items in this category, in times per year. For analytics only. A ratio rather than an amount, so it has no currency. Example: "8.00".
parentId string | null no The identifier of the category this one sits under. This is how a category is re-parented. Pass null to make it a top-level category. Re-parenting moves the whole subtree and touches no item: items stay assigned to the categories they already had. See id on GET inventory/item-categories/:id. 
{
  "name": "<name>",
  "description": "<description>",
  "active": true,
  "idealTurnoverRatio": "8.00",
  "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Under data (updateItemCategoryOutput):

Field Type Required Description
id string yes The unique identifier for the updated item category. Example: "a2f47b91-0c6d-4e38-95b1-7d3e6a428c50". 
{
  "data": {
    "id": "a2f47b91-0c6d-4e38-95b1-7d3e6a428c50"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
PARENT_NOT_FOUND 400
CATEGORY_CYCLE 400
CATEGORY_TOO_DEEP 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses