Square API
You are viewing an old version of the API
Inventory
Square API
Keep an inventory of catalog items in sync across all commerce channels.
The Inventory API provides the ability to perform a two-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.
-
Retrieve inventory adjustment
GET /v2/inventory/adjustments/{adjustment_id} - Returns the InventoryAdjustment object with the provided adjustment_id.
-
Batch change inventory
POST /v2/inventory/changes/batch-create - Applies adjustments and counts to the provided item quantities.
-
Batch retrieve inventory changes
POST /v2/inventory/changes/batch-retrieve - Returns historical physical counts and adjustments based on the provided filter criteria.
-
Batch retrieve inventory counts
POST /v2/inventory/counts/batch-retrieve - Returns current counts for the provided CatalogObjects at the requested Locations.
-
Retrieve inventory physical count
GET /v2/inventory/physical-counts/{physical_count_id} - Returns the InventoryPhysicalCount object with the provided physical_count_id.
-
Retrieve inventory transfer
GET /v2/inventory/transfers/{transfer_id} - Returns the InventoryTransfer object with the provided transfer_id.
BETA -
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.