Update Inventory Adjustment - Automate.ax

square.updateInventoryAdjustment applies an update to the provided adjustment.

Example

automations/square-update-inventory-adjustment.automation.ts

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

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

  square.updateInventoryAdjustment({
    idempotencyKey: "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe",
    adjustment: {},
  })
})

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 Build Basics section for more information.
`adjustment`	`Square.InventoryAdjustment`	Yes	—	Represents the updates being written to a past/existing inventory adjustment. This works using sparse updates, meaning that any fields omitted from the inputted InventoryAdjustment will retain their values. Only updates to the quantity, cost_money, vendor_id, and reason_id fields of an InventoryAdjustment can be made here. Note that the quantity field must be provided, but it can be identical to the current quantity if there are no desired quantity changes. cost_money and vendor_id can only be written to adjustments that add stock to the system (from_state of NONE or UNLINKED_RETURN) and to untracked sale adjustments. reason_id can be changed to any reason that is valid for the adjustment’s state transition. The reason of a system-generated adjustment (for example, SALE or RECOUNT) cannot be changed. Adjustments generated by Square from other records cannot be updated. This includes inferred adjustments created by physical counts, transfer-like cross-location adjustments, and component adjustments. Adjustments linked to purchase orders cannot be updated. Adjustments linked to sales can only have cost_money and vendor_id updated, and only for untracked sales. Restock adjustments linked to an itemized return can have their quantity updated, up to the quantity remaining on the return. Adjustments older than one year cannot be updated.

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

Output

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