Square

Square Inventory API

The Inventory API from Square — 13 operation(s) for inventory.

Documentation GitHub OpenAPI

Business capability

Operations 13

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v2/inventory/adjustment/{adjustment_id} Get an adjustment (deprecated URL) · Square Deprecated Retrieve Inventory Adjustment #

Ask an LLM

“Is there an older singular adjustment URL for reading an inventory adjustment?”

“What does the deprecated inventory adjustment lookup return?”

Tell an agent

Get inventory adjustment {adjustment_id} using the deprecated singular endpoint.

Fetch adjustment {adjustment_id} through the legacy /inventory/adjustment path.

GET /v2/inventory/adjustments/{adjustment_id} Get an inventory adjustment · Square Retrieve Inventory Adjustment #

Ask an LLM

“How do I view one inventory adjustment, like a sale or waste record?”

“Can I see what an inventory adjustment changed and when?”

Tell an agent

Get inventory adjustment {adjustment_id}.

Show me stock adjustment {adjustment_id} from the current adjustments endpoint.

POST /v2/inventory/batch-change Apply stock changes (deprecated URL) · Square Deprecated Batch Change Inventory #

Ask an LLM

“Is the old batch-change inventory URL still usable?”

“What does the deprecated batch-change endpoint do?”

Tell an agent

Apply inventory changes {changes} through the deprecated batch-change endpoint.

Use the legacy batch-change path to record {changes} with key {idempotency_key}.

POST /v2/inventory/batch-retrieve-changes Read stock history (deprecated URL) · Square Deprecated Batch Retrieve Inventory Changes #

Ask an LLM

“Is there a legacy batch-retrieve-changes URL for inventory history?”

“Does the deprecated changes lookup take the same filters as the new one?”

Tell an agent

Get inventory changes for {catalog_object_ids} via the deprecated batch-retrieve-changes endpoint.

Use the legacy endpoint to list stock history at locations {location_ids}.

POST /v2/inventory/batch-retrieve-counts Read stock counts (deprecated URL) · Square Deprecated Batch Retrieve Inventory Counts #

Ask an LLM

“Is the old batch-retrieve-counts URL still around for stock levels?”

“What does the deprecated inventory counts lookup return?”

Tell an agent

Get stock counts for {catalog_object_ids} via the deprecated batch-retrieve-counts endpoint.

Use the legacy counts path to check stock at {location_ids}.

POST /v2/inventory/changes/batch-create Adjust or recount stock in bulk · Square Batch Change Inventory #

Ask an LLM

“How do I record a stock recount or adjustment for many items at once?”

“Can I skip counts that haven't changed when updating inventory?”

Tell an agent

Apply inventory changes {changes}.

Record these stock adjustments and counts: {changes}, ignoring unchanged counts: {ignore_unchanged_counts}.

POST /v2/inventory/changes/batch-retrieve Search inventory change history · Square Batch Retrieve Inventory Changes #

Ask an LLM

“Where can I see the history of stock adjustments for my items?”

“Can I filter inventory history by date, location or change type?”

Tell an agent

List inventory changes for items {catalog_object_ids} at {location_ids}.

Show stock history updated after {updated_after} of types {types}.

POST /v2/inventory/counts/batch-retrieve Get current stock counts in bulk · Square Batch Retrieve Inventory Counts #

Ask an LLM

“How much stock do I have of several items across my locations?”

“Can I fetch counts only for items that changed recently?”

Tell an agent

Get current stock counts for {catalog_object_ids} at {location_ids}.

Show inventory counts changed since {updated_after}.

GET /v2/inventory/physical-count/{physical_count_id} Get a physical count (deprecated URL) · Square Deprecated Retrieve Inventory Physical Count #

Ask an LLM

“Is there an older singular physical-count URL for reading a stock count?”

“What does the deprecated physical count lookup return?”

Tell an agent

Get physical count {physical_count_id} using the deprecated singular endpoint.

Fetch count {physical_count_id} through the legacy /inventory/physical-count path.

GET /v2/inventory/physical-counts/{physical_count_id} Get a physical stock count · Square Retrieve Inventory Physical Count #

Ask an LLM

“How do I view the record of a manual stock count?”

“Can I see who counted an item and what quantity they recorded?”

Tell an agent

Get physical count {physical_count_id}.

Show recount record {physical_count_id} from the current physical-counts endpoint.

GET /v2/inventory/transfers/{transfer_id} Get an inventory transfer · Square Retrieve Inventory Transfer #

Ask an LLM

“How can I view a stock transfer between two locations?”

“What quantity moved in a particular inventory transfer?”

Tell an agent

Get inventory transfer {transfer_id}.

Show the details of stock transfer {transfer_id}.

GET /v2/inventory/{catalog_object_id} Get stock count for one item · Square Retrieve Inventory Count #

Ask an LLM

“How many units of this one item do I have in stock?”

“Can I check a single item's stock at specific locations?”

Tell an agent

Get the current stock count of {catalog_object_id}.

Check stock of item {catalog_object_id} at locations {location_ids}.

GET /v2/inventory/{catalog_object_id}/changes Get stock history for one item · Square Retrieve Inventory Changes #

Ask an LLM

“What adjustments and recounts has a single item had?”

“Can I see one product's inventory history at a location?”

Tell an agent

List inventory changes for item {catalog_object_id}.

Show stock history of {catalog_object_id} at {location_ids}.

Square Inventory API

Operations 13

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification