Create Catalog Image - Automate.ax

square.createCatalogImage uploads an image file to be represented by a CatalogImage object that can be linked to an existing CatalogObject instance.

Example

automations/square-create-catalog-image.automation.ts

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

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

  square.createCatalogImage({
    imageFile: new File(["image bytes"], "catalog.png", {
      type: "image/png",
    }),
    request: {
      idempotencyKey: crypto.randomUUID(),
      image: {
        id: "#catalog-image",
        imageData: {},
        type: "IMAGE",
      },
    },
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_WRITE.

Field	Type	Required	Default	Description
`request`	`Square.CreateCatalogImageRequest`	No	—	Square `request` request field.
`imageFile`	`File \| fs.ReadStream \| Blob \| undefined`	No	—	Square `imageFile` request field.

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

Output

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