Batch Retrieve Catalog Objects - Automate.ax

square.batchRetrieveCatalogObjects returns a set of objects based on the provided ID.

Example

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

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

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

  square.batchRetrieveCatalogObjects({
    objectIds: ["W62UWFY35CWMYGVWK6TWJDNI", "AA27W3M2GGTF3H6AVPNB77CK"],
    includeRelatedObjects: true,
  })
})

Inputs

Every input accepts a compatible signal. It requires ITEMS_READ.

Field	Type	Required	Default	Description
`objectIds`	`string[]`	Yes	—	The IDs of the CatalogObjects to be retrieved.
`includeRelatedObjects`	`boolean \| null`	No	—	If `true`, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field of the response. These objects are put in the `related_objects` field. Setting this to `true` is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example, if the `objects` field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `objects` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`
`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.
`includeDeletedObjects`	`boolean \| null`	No	—	Indicates whether to include (`true`) or not (`false`) in the response deleted objects, namely, those with the `is_deleted` attribute set to `true`.
`includeCategoryPathToRoot`	`boolean \| null`	No	—	Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned in the response payload.
`includeOptions`	`Square.IncludeOptions`	No	—	Options to include related resources in the response.

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

Output

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