Update a reason code

Operation ID: updateReasonCode

Group: Inventory › Reason Codes

Open in the interactive reference

PATCH /inventory/reason-codes/{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 a reason code with the fields you send. A field you leave out keeps its current value. A documentTypes list you send replaces the whole list, so include every document type you want to keep.

You can change the reason code's code, description, isActive, requiresApproval, and documentTypes. The response is only its id.

To add a document type, read the current documentTypes with GET inventory/reason-codes/:id and send them back with the new one.

To see the updated reason code, use GET inventory/reason-codes/: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 reason code you want to update.

Request body

Required, application/json: updateReasonCodeInput.

Field Type Required Description
code string no The business code of the reason code, for example 'DAMAGE'. It must stay unique within the tenant. Reusing the reason code's own current code is not a collision.
description string no A free-form description of what the reason code means.
isActive boolean no Whether the reason code can be selected on new documents. Set it to false to retire the reason code without deleting it: existing documents keep it and new ones cannot select it.
requiresApproval boolean no Whether documents using this reason code require approval before they take effect.
documentTypes array<any> no The complete set of document types this reason code may be selected on. It replaces the current set. Anything not listed is unlinked, and an empty array unlinks everything. Omit to leave the links unchanged. An unrecognized value fails the call with UNKNOWN_DOCUMENT_TYPES, which names every value it did not recognize. Example: ["InventoryDecrease","SalesReturn","Disposal"]. 
{
  "code": "<code>",
  "description": "<description>",
  "isActive": true,
  "requiresApproval": true,
  "documentTypes": [
    "InventoryDecrease",
    "SalesReturn",
    "Disposal"
  ]
}

Response

200 Success

Under data (updateReasonCodeOutput):

Field Type Required Description
id string yes The unique identifier for the reason code. Example: "7a1c9e42-8b30-4d67-9f15-3c8e02a74b61". 
{
  "data": {
    "id": "7a1c9e42-8b30-4d67-9f15-3c8e02a74b61"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
DUPLICATE_CODE 400
UNKNOWN_DOCUMENT_TYPES 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses