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

Instock Orders API

Intentions of users of Instock ASRS are represented by `orders` structure.Orders resource allows:* create/update/retrieve records for picking of goods from the ASRS (`customer` orders)* retrieve-only access to records for induction/adjustment/extraction of inventory(`adjustment`, `reception`, `extraction` orders)All operations with orders are performed in scope of a particular site and require`site_id` as a path parameter.The following kinds and statuses of orders are in use:| Order Kind | Description ||--------------|------------------------------------------------------------------------------------------------|| `customer` | order that needs to be fulfilled from ASRS and are placed by you, as client of API. || `adjustment` | order to correct current inventory. | | `reception` | order to receive goods or assets into ASRS, triggered by shipment from supplier, return of goods, etc. || `extraction` | order to extract assets from ASRS. || Order Status | Description ||----------------|-----------------------------------------------|| `registered` | order registered and awaiting for fulfillment in scope of ordertask(s).|| `reserved` | fulfillment in progress. || `done` | order has been fulfilled. | | `canceled` | order has been canceled. | **Note**: * only `customer` orders can be updated, and only while they are in status `registered`. Once orderfulfillment has started Instock ASRS freezes (makes read-only) customer orders.* custom `attributes` object values are optional and defined upon initial integration with Incloud.

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

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

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

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

7 operations 3 paths 12 schemas 1 DELETE3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Orders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Orders 7

Intentions of users of Instock ASRS are represented by orders structure. Orders resource allows: create/update/retrieve records for picking of goods from the ASRS (customer orders…

POST
/{site_id}/orders
Create customer order
addOrder 2 params body → 200400401403404500
GET
/{site_id}/orders
List all orders
ListSiteOrders 4 params → 200400401403404500
PUT
/{site_id}/orders/{order_id}
Update customer order
updateOrder 3 params body → 200400401403404500
GET
/{site_id}/orders/{order_id}
Retrieve order
getOrder 3 params → 200400401403404500
GET
/{site_id}/orders/{order_id}/status
Retrieve order status
getOrderStatus 3 params → 200400401403404500
POST
/{site_id}/orders/{order_id}/status
Advance order status
advanceOrderStatus 3 params body → 201404500
DELETE
/{site_id}/orders/{order_id}/status
Cancel registered order
cancelRegisteredOrder 3 params → 200400404500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are order (7 properties), getSingleOrder (7 properties), orderStatus (7 properties), listSiteOrders (5 properties). Each schema is shown below with its type and property counts.

toCellId
string
ID of the target storage cell to which a specific article moved.
lineId
string
ID of an order line. Unique in scope of your organization(s).
Error
object
2 properties
orderId
string
ID of an order. Unique in scope of your organization(s).
getSingleOrder
object
7 properties
articleId
string
ID of an article. Unique in scope of your organization(s).
order
object
7 properties
orderStatus
object
7 properties
listSiteOrders
object
5 properties
siteId
string
ID of Instock site. Globally unique.
orderStatusRequestTimestamp
string
Timestamp of order status request [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).
placedAtTimestamp
string
Time when order was placed [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instock-orders-api-openapi.yml Raw ↑

Other APIs Instock publishes across the network.

Instock Articles API
Instock Inventory API
Instock Moves API
Instock Ordertasks API
Instock Sites API
Where this information came from

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