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 Orders. 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.1.0, at version 0.1.0.
Requests are made against a single base URL, https://api.instock.com/v1.
Metadata
The identity and technical contract details declared by the specification.
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.
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…
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are getSingleOrder (7 properties), orderStatus (7 properties), order (7 properties), listSiteOrders (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Instock 5
Other APIs Instock publishes across the network.