Batch Delete Catalog Objects - Automate.ax

square.batchDeleteCatalogObjects deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response.

Example

automations/square-batch-delete-catalog-objects.automation.ts

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

export default automation("Batch Square Delete Catalog Objects", () => {
  onDashboardRun({ title: "Batch Square Delete Catalog Objects" })

  square.batchDeleteCatalogObjects({
    objectIds: ["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"],
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_WRITE.

Field	Type	Required	Default	Description
`objectIds`	`string[]`	Yes	—	The IDs of the CatalogObjects to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a CatalogItem will delete its CatalogItemVariation.

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

Output

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