Create inventory adjustment reasonBeta

POST

/v2/inventory/adjustment-reasons/create

Creates a custom inventory adjustment reason.

Permissions:INVENTORY_WRITE

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A client-supplied, universally unique identifier to make this CreateInventoryAdjustmentReason request idempotent.

Min Length

Max Length

128

Link to section

adjustment_reason

Required

The custom inventory adjustment reason to create. Only custom adjustment reasons can be created.

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Link to section

adjustment_reason

The successfully created inventory adjustment reason.

Link to section

Examples

All versions ->

POST /v2/inventory/adjustment-reasons/create

curl https://connect.squareup.com/v2/inventory/adjustment-reasons/create \
  -X POST \
  -H 'Square-Version: 2026-07-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "27b2f2b1-1c2a-4b9e-8f3a-0d9c3a1e5b47",
    "adjustment_reason": {
      "id": {
        "type": "CUSTOM"
      },
      "name": "Donated to charity",
      "direction": "DECREASE"
    }
  }'

Response JSON

{
  "errors": [],
  "adjustment_reason": {
    "id": {
      "type": "CUSTOM",
      "custom_reason_id": "R5BX3PDCZ6EXAMPLE"
    },
    "name": "Donated to charity",
    "direction": "DECREASE",
    "created_at": "2026-07-15T18:24:31.000Z",
    "updated_at": "2026-07-15T18:24:31.000Z",
    "is_deleted": false
  }
}