List Catalog - Automate.ax

square.listCatalog returns a list of all CatalogObjects of the specified types in the catalog.

Example

automations/square-list-catalog.automation.ts

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

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

  square.listCatalog({
    cursor: "cursor",
    types: "types",
    catalogVersion: BigInt("1000000"),
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information.
`types`	`string \| null`	No	—	An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the CatalogObjectType enum, for example, `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc. If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults. At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
`catalogVersion`	`bigint \| null`	No	—	The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects’ `version` attribute. If not included, results will be from the current version of the catalog.

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

Output

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