Instock Ordertasks API
Fulfillment of orders by associates and ASRS is split into chunks called `ordertasks`.An `ordertask` can represent a picking of several lines of customer order, for example.Each ordertask corresponds to exactly one order and one order can have multiple ordertasks.On the other side, each action of robots of ASRS can be attributed back to exactly one ordertask.Incloud promises, once order gets into one of the terminal statuses (`done` or `canceled`) the setof corresponding ordertasks is immutable, i.e. no new ordertasks to be added, and each ordertask recordis immutable.Ordertasks corresponding to customer order are created after order fulfillment is planned, i.e. afterorder status changes from `registered` to `reserved`.Once customer order is `done` or `canceled`, a client of API can reconstruct full picture of fulfillment of order by retrieving ordertasks data.Ordertasks may be presented by Incloud for all type of orders(`customer`, `reception`, `adjustment`, `extraction`).| Ordertask status | Description ||----------------|---------------|| `reserved` | ordertask is in progress. || `done` | ordertask has been completed. | | `canceled` | ordertask has been canceled. |
Instock Ordertasks API is one of 6 APIs that Instock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Ordertasks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 1 operation across 1 path, and defines 7 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 Ordertasks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Fulfillment of orders by associates and ASRS is split into chunks called ordertasks. An ordertask can represent a picking of several lines of customer order, for example. Each ord…
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are orderTask (6 properties), Error (2 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.