Retrieve Inventory Adjustment Reason - Automate.ax

square.retrieveInventoryAdjustmentReason returns the inventory adjustment reason identified by the provided reason_id.

Example

automations/square-retrieve-inventory-adjustment-reason.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Retrieve Square Inventory Adjustment Reason", () => {
  onDashboardRun({ title: "Retrieve Square Inventory Adjustment Reason" })

  square.retrieveInventoryAdjustmentReason({
    reasonId: {
      type: "CUSTOM",
      customReasonId: "R5BX3PDCZ6EXAMPLE",
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_READ.

Field	Type	Required	Default	Description
`reasonId`	`Square.InventoryAdjustmentReasonId`	Yes	—	The identifier of the inventory adjustment reason to retrieve.

Use the official RetrieveInventoryAdjustmentReason reference for provider field semantics and limits.

Output

Returns the official Square.RetrieveInventoryAdjustmentReasonResponse response as a codec-safe object. Square integer money amounts remain bigint values.