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

Whiplash Merchandising items API

Items are probably the most fundamental entity in the Whiplash system. An item is simply a 'shippable unit'. So, it's not a Whiplash T-Shirt; it's a Small Whiplash T-Shirt, for instance.Most commerce platforms model Products. Typically, however, a Product (e.g. a T-Shirt) has variations (named variously, Variants, ProductOptions, OptionSets, etc). An Item maps to the Variant/Option, not the Product.

Whiplash Merchandising items API is one of 21 APIs that Whiplash Merchandising 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, and an API reference.

This API exposes 23 operations across 18 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against the base URL https://www.getwhiplash.com/api/v2.

23 operations 18 paths 20 schemas 1 DELETE17 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://www.getwhiplash.com/api/v2
Resource Areas
1

Paths & Operations 23

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

items 23

Items are probably the most fundamental entity in the Whiplash system. An item is simply a 'shippable unit'. So, it's not a Whiplash T-Shirt; it's a Small Whiplash T-Shirt, for in…

GET
/api/v2/items
List all items
GetApiV2Items 7 params → 200401403
POST
/api/v2/items
Create an item
PostApiV2Items body → 201401403409422
GET
/api/v2/items/actions
List actions you can perform
GetApiV2ItemsActions → 401403
GET
/api/v2/items/count
Count items
GetApiV2ItemsCount 1 param → 200401403
GET
/api/v2/items/{id}
Retrieve an item
GetApiV2ItemsId 1 param → 200401403
PUT
/api/v2/items/{id}
Update an item
PutApiV2ItemsId 1 param body → 200401403422
DELETE
/api/v2/items/{id}
Archive an item
DeleteApiV2ItemsId 1 param → 204401403422
GET
/api/v2/items/{id}/bundle_items
List all bundle items containing this item
GetApiV2ItemsIdBundleItems 1 param → 200401403
POST
/api/v2/items/{id}/bundle_items
Add an item to an bundle
PostApiV2ItemsIdBundleItems 1 param body → 201401403
PUT
/api/v2/items/{id}/call/{action}
Perform an action on an item
PutApiV2ItemsIdCallAction 2 params body → 200401403405422
GET
/api/v2/items/{id}/in_bundles
List all instances of this item in bundles
GetApiV2ItemsIdInBundles 1 param → 200401403
GET
/api/v2/items/{id}/locations_with_transfer_count
List locations associated with this item - by role
GetApiV2ItemsIdLocationsWithTransferCount 5 params → 200401403
GET
/api/v2/items/{id}/meta_fields
List meta fields
GetApiV2ItemsIdMetaFields 2 params → 200401403
PUT
/api/v2/items/{id}/meta_fields
Set meta fields
PutApiV2ItemsIdMetaFields 1 param body → 204401403422
GET
/api/v2/items/{id}/originators
List associated originators
GetApiV2ItemsIdOriginators 7 params → 200401403
GET
/api/v2/items/{id}/originators/count
Count originators
GetApiV2ItemsIdOriginatorsCount 2 params → 200401403
GET
/api/v2/items/{id}/scancodes
List all scancodes associated with this item
GetApiV2ItemsIdScancodes 7 params → 200401403
GET
/api/v2/items/{id}/shipnotice_items
List associated ship notice items
GetApiV2ItemsIdShipnoticeItems 8 params → 200401403
GET
/api/v2/items/{id}/shipnotice_items/count
Count associated ship notice items
GetApiV2ItemsIdShipnoticeItemsCount 2 params → 200401403
GET
/api/v2/items/{id}/transactions
List an item's history
GetApiV2ItemsIdTransactions 7 params → 200401403
GET
/api/v2/items/{id}/transactions/count
Count the transactions in an item's history
GetApiV2ItemsIdTransactionsCount 2 params → 200401403
GET
/api/v2/items/{id}/transactions/export
Export an item's transaction history
GetApiV2ItemsIdTransactionsExport 1 param → 200401403
GET
/api/v2/items/{id}/warehouse_quantities
Item stock by warehouse
GetApiV2ItemsIdWarehouseQuantities 1 param → 200401403

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesItem (59 properties), PostApiV2ItemsRequest (53 properties), PutApiV2ItemsIdRequest (51 properties), ApiV2EntitiesItemWarehouseQuantity (48 properties). Each schema is shown below with its type and property counts.

PutApiV2ItemsIdMetaFieldsRequest
object
2 properties
ApiV2EntitiesTransaction
object
12 properties
ApiSharedEntitiesMetaFields
object
2 properties
ApiV2EntitiesItem
object
59 properties
ApiV2EntitiesItemWarehouseQuantity
object
48 properties
ApiV2EntitiesBundleItem
object
10 properties
PostApiV2ItemsIdBundleItemsRequest
object
2 properties 2 required
ApiV2EntitiesCount
object
1 property
PutApiV2ItemsIdRequest
object
51 properties
ApiV2EntitiesWarehouse
object
45 properties
ApiV2EntitiesLot
object
6 properties
ApiV2EntitiesResult
object
1 property
ApiV2EntitiesShipnoticeItem
object
28 properties
ApiV2EntitiesOriginator
object
18 properties
ApiV2EntitiesWarehouseFeature
object
6 properties
ApiV2EntitiesItemLocation
object
10 properties
PutApiV2ItemsIdCallActionRequest
object
2 properties
ApiV2EntitiesScancode
object
10 properties
ApiSharedEntitiesApiError
object
1 property
PostApiV2ItemsRequest
object
53 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-items-api-openapi.yml Raw ↑

Other APIs Whiplash Merchandising publishes across the network.

Whiplash Merchandising bundle_items API
Whiplash Merchandising consumer_returns API
Whiplash Merchandising customers API
Whiplash Merchandising documents API
Whiplash Merchandising load_scacs API
Whiplash Merchandising notification_events API
Whiplash Merchandising notification_subscriptions API
Whiplash Merchandising order_documents API
Whiplash Merchandising order_items API
Whiplash Merchandising order_totes API
Whiplash Merchandising orders API
Whiplash Merchandising originators API