Square API
You are viewing an old version of the API
Inventory
Square API
Keep inventory of catalog items in sync across all commerce channels
The Inventory API provides the ability to do a 2-way sync between your inventory system and Square using catalog items. You can poll Square's inventory counts to update your system, and update counts in Square using the batch change inventory request.
Endpoints
You are viewing an old version of the API
-
Retrieve inventory adjustment
GET /v2/inventory/adjustment/{adjustment_id} - Returns the InventoryAdjustment object with the provided adjustment_id
-
Batch change inventory
POST /v2/inventory/batch-change - Applies adjustments and counts to the provided item quantities
-
Batch retrieve inventory changes
POST /v2/inventory/batch-retrieve-changes - Returns historical physical counts and adjustments based on the provided filter criteria
-
Batch retrieve inventory counts
POST /v2/inventory/batch-retrieve-counts - Returns current counts for the provided CatalogObjects at the requested Locations
-
Retrieve inventory physical count
GET /v2/inventory/physical-count/{physical_count_id} - Returns the InventoryPhysicalCount object with the provided physical_count_id
-
Retrieve inventory count
GET /v2/inventory/{catalog_object_id} - Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations
-
Retrieve inventory changes
GET /v2/inventory/{catalog_object_id}/changes - Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations
V1 Endpoints
Some operations require use of Connect V1 endpoints. See When to use Connect V1 to learn more.