List Inventory Adjustment Reasons - Automate.ax

square.listInventoryAdjustmentReasons returns the standard and custom inventory adjustment reasons available to the seller.

Example

automations/square-list-inventory-adjustment-reasons.automation.ts

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

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

  square.listInventoryAdjustmentReasons({
    includeDeleted: true,
    includeSystemCodes: true,
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_READ.

Field	Type	Required	Default	Description
`includeDeleted`	`boolean \| null`	No	`false`	Indicates whether the response should include deleted custom inventory adjustment reasons. The default value is `false`.
`includeSystemCodes`	`boolean \| null`	No	`false`	Indicates whether the response should include Square-generated system inventory adjustment reason codes that cannot be used to write adjustments from the Connect API, such as `SALE`, `RECOUNT`, `TRANSFER`, `IN_TRANSIT`, and `CANCELED_SALE`. The default value is `false`.

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

Output

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