How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square Inventory API

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

Square Inventory API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Inventory. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 13 operations across 13 paths, and defines 36 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

13 operations 13 paths 36 schemas 7 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Inventory API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 13

Across 13 paths, the API surfaces 13 operations — 7 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Inventory 13
GET
/v2/inventory/adjustment/{adjustment_id}deprecated
Square Deprecated Retrieve Inventory Adjustment
DeprecatedRetrieveInventoryAdjustment 1 param → 200
GET
/v2/inventory/adjustments/{adjustment_id}
Square Retrieve Inventory Adjustment
RetrieveInventoryAdjustment 1 param → 200
POST
/v2/inventory/batch-changedeprecated
Square Deprecated Batch Change Inventory
DeprecatedBatchChangeInventory body → 200
POST
/v2/inventory/batch-retrieve-changesdeprecated
Square Deprecated Batch Retrieve Inventory Changes
DeprecatedBatchRetrieveInventoryChanges body → 200
POST
/v2/inventory/batch-retrieve-countsdeprecated
Square Deprecated Batch Retrieve Inventory Counts
DeprecatedBatchRetrieveInventoryCounts body → 200
POST
/v2/inventory/changes/batch-create
Square Batch Change Inventory
BatchChangeInventory body → 200
POST
/v2/inventory/changes/batch-retrieve
Square Batch Retrieve Inventory Changes
BatchRetrieveInventoryChanges body → 200
POST
/v2/inventory/counts/batch-retrieve
Square Batch Retrieve Inventory Counts
BatchRetrieveInventoryCounts body → 200
GET
/v2/inventory/physical-count/{physical_count_id}deprecated
Square Deprecated Retrieve Inventory Physical Count
DeprecatedRetrieveInventoryPhysicalCount 1 param → 200
GET
/v2/inventory/physical-counts/{physical_count_id}
Square Retrieve Inventory Physical Count
RetrieveInventoryPhysicalCount 1 param → 200
GET
/v2/inventory/transfers/{transfer_id}
Square Retrieve Inventory Transfer
RetrieveInventoryTransfer 1 param → 200
GET
/v2/inventory/{catalog_object_id}
Square Retrieve Inventory Count
RetrieveInventoryCount 3 params → 200
GET
/v2/inventory/{catalog_object_id}/changesdeprecated
Square Retrieve Inventory Changes
RetrieveInventoryChanges 3 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are InventoryAdjustment (19 properties), InventoryTransfer (13 properties), InventoryPhysicalCount (12 properties), MeasurementUnit (8 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
MeasurementUnitUnitType
string
Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
InventoryChangeType
string
Indicates how the inventory change was applied to a tracked product quantity.
InventoryAdjustment
object
Represents a change in state or quantity of product inventory at a particular time and location.
19 properties
InventoryChange
object
Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](entity…
6 properties
BatchChangeInventoryRequest
object
3 properties 1 required
InventoryCount
object
Represents Square-estimated quantity of items in a particular state at a particular seller location based on the known history of physical counts and inventory…
7 properties
MeasurementUnitCustom
object
The information needed to define a custom unit, provided by the seller.
2 properties 2 required
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
BatchRetrieveInventoryChangesRequest
object
8 properties
InventoryAdjustmentGroup
object
4 properties
Product
string
Indicates the Square product used to generate a change.
BatchRetrieveInventoryCountsResponse
object
3 properties
BatchChangeInventoryResponse
object
3 properties
MeasurementUnitGeneric
string
MeasurementUnitWeight
string
Unit of weight used to measure a quantity.
BatchRetrieveInventoryCountsRequest
object
6 properties
RetrieveInventoryAdjustmentResponse
object
2 properties
InventoryPhysicalCount
object
Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a phy…
12 properties
InventoryState
string
Indicates the state of a tracked item quantity in the lifecycle of goods.
CatalogMeasurementUnit
object
Represents the unit used to measure a CatalogItemVariation and specifies the precision for decimal quantities.
2 properties
MeasurementUnit
object
Represents a unit of measurement to use with a quantity, such as ounces or inches. Exactly one of the following fields are required: customunit, areaunit, leng…
8 properties
MeasurementUnitTime
string
Unit of time used to measure a quantity (a duration).
RetrieveInventoryChangesResponse
object
3 properties
RetrieveInventoryPhysicalCountResponse
object
2 properties
RetrieveInventoryCountResponse
object
3 properties
MeasurementUnitArea
string
Unit of area used to measure a quantity.
InventoryTransfer
object
Represents the transfer of a quantity of product inventory at a particular time from one location to another.
13 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
MeasurementUnitVolume
string
The unit of volume used to measure a quantity.
SourceApplication
object
Represents information about the application used to generate a change.
3 properties
BatchRetrieveInventoryChangesResponse
object
3 properties
RetrieveInventoryTransferResponse
object
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
MeasurementUnitLength
string
The unit of length used to measure a quantity.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-inventory-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Inventory API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.