Whiplash Items API
Inventory item management — list, create, count, retrieve, update, archive, bundles, actions, locations, meta fields, originators, scancodes, history, and stock by warehouse
Whiplash Items API is one of 10 APIs that Whiplash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.
This API exposes 20 operations across 18 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.0.
Requests are made against a single base URL, https://api.getwhiplash.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Whiplash Items API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuth2) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— OAuth 2.0 Bearer token. Obtain via authorization code or client credentials flow. See https://help.whiplash.com/hc/en-us/articles/360050870691-Authentication-f…
Paths & Operations 20
Across 18 paths, the API surfaces 20 operations — 17 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Inventory item management — list, create, count, retrieve, update, archive, bundles, actions, locations, meta fields, originators, scancodes, history, and stock by warehouse
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Item (12 properties), ItemInput (7 properties), CustomField (2 properties), CountResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Whiplash 9
Other APIs Whiplash publishes across the network.