Delete Catalog Object - Automate.ax

square.deleteCatalogObject deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response.

Example

automations/square-delete-catalog-object.automation.ts

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

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

  square.deleteCatalogObject({
    objectId: "object_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_WRITE.

Field	Type	Required	Default	Description
`objectId`	`string`	Yes	—	The ID of the catalog object 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 catalog item will delete its catalog item variations).

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

Output

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