Home / Servers / Square API / retrieve_inventory_count

RetrieveInventoryCount

An MCP tool from the Square API server, hosted on mcp.hjlabs.in.

RetrieveInventoryCount Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint. [GET /v2/inventory/{catalog_object_id}]

Name on the gateway: square_api__retrieve_inventory_count · read-only.

Parameters

NameTypeDescription
catalog_object_id requiredstringID of the CatalogObject to retrieve.
location_idsstringThe Location IDs to look up as a comma-separated list. An empty list queries…
cursorstringA pagination cursor returned by a previous call to this endpoint. Provide this…

How to call it

Through the Smart Gateway, any client can run it by name with call_tool, or let the gateway find it with search_tools:

call_tool arguments
{
  "name": "square_api__retrieve_inventory_count",
  "arguments": {
    "catalog_object_id": "…"
  }
}

Or connect the Square API server directly, which lists 308 tools including this one:

Run in your terminal
claude mcp add --transport http hj-square-api https://mcp.hjlabs.in/mcp/square-api \
  --header "Authorization: Bearer YOUR_API_KEY"

Try asking

Use the retrieveinventorycount tool with catalog_object_id set to ….

More from Square API