Retrieve Inventory Count - Automate.ax

square.retrieveInventoryCount retrieves the current calculated stock count for a given CatalogObject at a given set of Locations.

Example

automations/square-retrieve-inventory-count.automation.ts

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

export default automation("Retrieve Square Inventory Count", () => {
  onDashboardRun({ title: "Retrieve Square Inventory Count" })

  square.retrieveInventoryCount({
    catalogObjectId: "catalog_object_id",
    locationIds: "location_ids",
    cursor: "cursor",
  })
})

Inputs

Every input accepts a compatible signal. It requires INVENTORY_READ.

Field	Type	Required	Default	Description
`catalogObjectId`	`string`	Yes	—	ID of the CatalogObject to retrieve.
`locationIds`	`string \| null`	No	—	The Location IDs to look up as a comma-separated list. An empty list queries all locations.
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.

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

Output

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