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

Instock Inventory API

Inventory resource returns data on the current quantity of article(s) that your organization has uploaded, use it to track articles that are low in stock or out-of-stock and require replenishment in scope of particular site.

Instock Inventory API is one of 6 APIs that Instock 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, API documentation, an API reference, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against a single base URL, https://api.instock.com/v1.

4 operations 2 paths 10 schemas 2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.instock.com/v1
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

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

Paths & Operations 4

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

Inventory 4

Inventory resource returns data on the current quantity of article(s) that your organization has uploaded, use it to track articles that are low in stock or out-of-stock and requi…

GET
/{site_id}/inventory
List all articles inventory
getAllInventory 4 params → 200400401403404500
POST
/{site_id}/inventory
Retrieve multiple articles inventory
retrieveMultipleArticlesInventory 2 params body → 200400401403404
PUT
/{site_id}/inventory
Adjust article inventory
adjustArticleInventory 2 params body → 200400500
GET
/{site_id}/inventory/{article_id}
Retrieve article inventory
getInventoryArticleId 3 params → 200400401403404500

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are inventoryQtyAllArticles (6 properties), inventoryQtyArticleId (5 properties), inventoryQtyMultipleArticlesResponse (4 properties), Error (2 properties). Each schema is shown below with its type and property counts.

adjustArticleInventory
object
2 properties
inventoryQtyArticleId
object
5 properties
inventoryQtyMultipleArticlesRequest
object
1 property
siteId
string
ID of Instock site. Globally unique.
articleId
string
ID of an article. Unique in scope of your organization(s).
inventoryQtyAllArticles
object
6 properties
adjustInventory
object
1 property
inventoryQtyMultipleArticlesResponse
object
4 properties
Error
object
2 properties
inventoryRetrievalTimestamp
string
Timestamp of inventory retrieval from database [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instock-inventory-api-openapi.yml Raw ↑

Other APIs Instock publishes across the network.

Instock Articles API
Instock Moves API
Instock Orders API
Instock Ordertasks API
Instock Sites API