Update Item Modifier Lists - Automate.ax

square.updateItemModifierLists updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

Example

automations/square-update-item-modifier-lists.automation.ts

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

export default automation("Update Square Item Modifier Lists", () => {
  onDashboardRun({ title: "Update Square Item Modifier Lists" })

  square.updateItemModifierLists({
    itemIds: ["H42BRLUJ5KTZTTMPVSLFAACQ", "2JXOBJIHCWBQ4NZ3RIXQGJA6"],
    modifierListsToEnable: [
      "H42BRLUJ5KTZTTMPVSLFAACQ",
      "2JXOBJIHCWBQ4NZ3RIXQGJA6",
    ],
    modifierListsToDisable: ["7WRC16CJZDVLSNDQ35PP6YAD"],
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_WRITE.

Field	Type	Required	Default	Description
`itemIds`	`string[]`	Yes	—	The IDs of the catalog items associated with the CatalogModifierList objects being updated.
`modifierListsToEnable`	`string[] \| null`	No	—	The IDs of the CatalogModifierList objects to enable for the CatalogItem. At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.
`modifierListsToDisable`	`string[] \| null`	No	—	The IDs of the CatalogModifierList objects to disable for the CatalogItem. At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified.

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

Output

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