Batch Change Inventory - Automate.ax

square.batchChangeInventory applies adjustments and counts to the provided item quantities.

Example

automations/square-batch-change-inventory.automation.ts

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

export default automation("Batch Square Change Inventory", () => {
  onDashboardRun({ title: "Batch Square Change Inventory" })

  square.batchChangeInventory({
    idempotencyKey: crypto.randomUUID(),
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_WRITE.

Field	Type	Required	Default	Description
`idempotencyKey`	`string`	Yes	—	A client-supplied, universally unique identifier (UUID) for the request. See Idempotency in the API Development 101 section for more information.
`changes`	`Square.InventoryChange[] \| null`	No	—	The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order.
`ignoreUnchangedCounts`	`boolean \| null`	No	`true`	Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`.

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

Output

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