Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Inventory API

The Inventory API allows you to manage stock for products at both organization and store levels. Each product keeps a history of inventory transactions, enabling easier stock auditing.You can specify an initial stock level when you create a product. The stock is set to `0` by default.:::caution You cannot create multiple inventories of the same organization-level product in different stores because no unique stock ID, specific to each store, is currently generated. Hence, when you try to manage inventory of the same product for different stores, you get an invalid product identifier error. :::

Elastic Path Inventory API is one of 100 APIs that Elastic Path 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 7 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

7 operations 3 paths 20 schemas 1 DELETE2 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 7

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

Inventory 7

The Inventory API allows you to manage stock for products at both organization and store levels. Each product keeps a history of inventory transactions, enabling easier stock audi…

GET
/inventories
Get Stock for all Products
GetStockForAllProducts 2 params → 200404500
POST
/inventories
Create Stock for Product
CreateStock body → 201400500
POST
/inventories/multiple
Get Stock for Multiple Products
GetStockForMultipleProducts body → 200404500
POST
/inventories/{product_uuid}
Create Stock for Product
CreateProductStock 1 param body → 201400404500
GET
/inventories/{product_uuid}
Get Stock for Product
GetProductStock 1 param → 200404500
DELETE
/inventories/{product_uuid}
Delete Stock for Product
DeleteStock 1 param → 204400404500
PUT
/inventories/{product_uuid}
Update Stock for Product
UpdateStock 1 param body → 200400404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Inventory (7 properties), Error (4 properties), StockResponseAttributes (4 properties), StockResponse (4 properties). Each schema is shown below with its type and property counts.

Timestamps_2
object
2 properties 1 required
StockCreate
object
3 properties 2 required
Timestamps
object
2 properties
Error
object
4 properties 2 required
MultipleProducts
object
2 properties 1 required
Meta
Inventory
object
7 properties 5 required
ErrorResponse
object
1 property 1 required
StockResponseAttributes
object
4 properties 3 required
StockMeta
object
2 properties 2 required
StockUpdateAttributes
object
1 property
StockType
string
StockLocations
object
StockUpdateRequest
object
3 properties 3 required
StockCreateAttributes
object
2 properties
InventoryCreate
object
1 property
NullableLocations
object
NullableLocation
object
1 property 1 required
UUID
string
The unique identifier.
StockResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-inventory-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API