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

magento Inventory API

Multi-source inventory management including sources, stocks, stock-source links, and source item quantity management.

magento Inventory API is one of 16 APIs that Magento publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.4.

Requests are made against a single base URL, https://{store_domain}/rest/{store_code}.

6 operations 3 paths 7 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.4
Base URL
https://your-store.example.com/rest
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

magento Inventory API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token obtained from the /V1/integration/admin/token or /V1/integration/customer/token endpoint. Include in the Authorization header as "Bearer {token}".

Paths & Operations 6

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

Inventory 6

Multi-source inventory management including sources, stocks, stock-source links, and source item quantity management.

GET
/V1/inventory/sources
List inventory sources
listInventorySources 4 params → 200401
POST
/V1/inventory/sources
Create an inventory source
createInventorySource body → 200400401
GET
/V1/inventory/sources/{sourceCode}
Get inventory source by code
getInventorySource 1 param → 200401404
PUT
/V1/inventory/sources/{sourceCode}
Update an inventory source
updateInventorySource 1 param body → 200400401404
GET
/V1/inventory/source-items
List source item quantities
listSourceItems 4 params → 200401
POST
/V1/inventory/source-items
Update source item quantities
updateSourceItems body → 200400401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are InventorySource (11 properties), SourceItem (4 properties), Error (2 properties), SourceItemSearchResults (2 properties). Each schema is shown below with its type and property counts.

InventorySource
object
An inventory source representing a fulfillment location in multi-source inventory.
11 properties
InventorySourceSearchResults
object
Paginated search results containing a list of inventory sources.
2 properties
SourceItemSearchResults
object
Paginated search results containing a list of source items.
2 properties
SourceItemUpdateRequest
object
Request body for bulk updating source item quantities.
1 property 1 required
InventorySourceRequest
object
Request body for creating or updating an inventory source.
1 property 1 required
SourceItem
object
A source item representing the quantity of a product at a specific inventory source.
4 properties
Error
object
Standard error response returned for 4xx and 5xx responses.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magento-inventory-api-openapi.yml Raw ↑

Other APIs Magento publishes across the network.

Magento GraphQL API
Magento SOAP API
Adobe Commerce Webhooks
Adobe Commerce Admin UI SDK
Adobe Commerce Eventing
magento Authentication API
magento Carts API
magento Categories API
magento Customers API
magento Invoices API
magento Orders API
magento Products API
Where this information came from

This is an independent, third-party profile of magento 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.