Update inventory adjustment reasonBeta

PUT

/v2/inventory/adjustment-reasons/update

Updates a custom inventory adjustment reason.

Permissions:INVENTORY_WRITE

Try in API Explorer

Link to section

Request body

Example code

Link to section

reason_id

Required

The identifier of the custom inventory adjustment reason to update.

Link to section

adjustment_reason

Required

The requested custom inventory adjustment reason update. Only the name field can be updated. Deleted custom reasons cannot be updated. To restore a deleted custom reason, call RestoreInventoryAdjustmentReason.

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Link to section

adjustment_reason

The successfully updated inventory adjustment reason.

Link to section

Examples

All versions ->

PUT /v2/inventory/adjustment-reasons/update

curl https://connect.squareup.com/v2/inventory/adjustment-reasons/update \
  -X PUT \
  -H 'Square-Version: 2026-07-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason_id": {
      "type": "CUSTOM",
      "custom_reason_id": "R5BX3PDCZ6EXAMPLE"
    },
    "adjustment_reason": {
      "id": {
        "type": "CUSTOM",
        "custom_reason_id": "R5BX3PDCZ6EXAMPLE"
      },
      "name": "Charitable donation"
    }
  }'

Response JSON

{
  "errors": [],
  "adjustment_reason": {
    "id": {
      "type": "CUSTOM",
      "custom_reason_id": "R5BX3PDCZ6EXAMPLE"
    },
    "name": "Charitable donation",
    "direction": "DECREASE",
    "created_at": "2026-07-15T18:24:31.000Z",
    "updated_at": "2026-07-15T19:02:07.000Z",
    "is_deleted": false
  }
}