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 Articles API

Instock is using the term `article` to describe unique product or SKU managed by Instock ASRS.Articles resource is mostly managed by you as a client of Instock API.Article data is shared across all sites that belong to your organization.**Note**: * currently articles with `is_serial_numbered: true` value cannot be uploaded or updated, Incloud will yield an error. * `attributes` object can contain both custom and pre-defined values. Custom attributes defined upon initial integration with Incloud.

Instock Articles API is one of 6 APIs that Instock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Articles. 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 5 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 5 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 Articles 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.

Articles 4

Instock is using the term article to describe unique product or SKU managed by Instock ASRS. Articles resource is mostly managed by you as a client of Instock API. Article data is…

POST
/articles
Upload article(s)
uploadArticles 1 param body → 200400401403500
GET
/articles
List all articles
listArticles 3 params → 200400401403500
GET
/articles/{article_id}
Retrieve article
getArticle 2 params → 200400401403404500
PUT
/articles/{article_id}
Update article
updateArticle 2 params body → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are article (5 properties), listArticles (3 properties), Error (2 properties), createArticles (1 property). Each schema is shown below with its type and property counts.

listArticles
object
3 properties
Error
object
2 properties
articleId
string
ID of an article. Unique in scope of your organization(s).
article
object
5 properties
createArticles
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instock-articles-api-openapi.yml Raw ↑

Other APIs Instock publishes across the network.

Instock Inventory API
Instock Moves API
Instock Orders API
Instock Ordertasks API
Instock Sites API