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 order_items API

An OrderItem represents an Item with a quantity in an Order.

Whiplash Merchandising order_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 order_items. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 11 operations across 7 paths, and defines 10 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.

11 operations 7 paths 10 schemas 1 DELETE5 GET5 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 11

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

order_items 11

An OrderItem represents an Item with a quantity in an Order.

GET
/api/v2/order_items/actions
List actions you can perform
GetApiV2OrderItemsActions → 401403
GET
/api/v2/order_items/{id}
Retrieve an order item
GetApiV2OrderItemsId 5 params → 200401403
PUT
/api/v2/order_items/{id}
Update an order item
PutApiV2OrderItemsId 1 param body → 200401403422
DELETE
/api/v2/order_items/{id}
Destroy an order item
DeleteApiV2OrderItemsId 1 param → 204401403422
PUT
/api/v2/order_items/{id}/call/{action}
Perform an action on an orderitem
PutApiV2OrderItemsIdCallAction 2 params body → 200401403405422
GET
/api/v2/order_items/{id}/meta_fields
List meta fields
GetApiV2OrderItemsIdMetaFields 2 params → 200401403
PUT
/api/v2/order_items/{id}/meta_fields
Set meta fields
PutApiV2OrderItemsIdMetaFields 1 param body → 204401403422
PUT
/api/v2/order_items/{id}/separate
Separate an order item
PutApiV2OrderItemsIdSeparate 1 param → 200401403422
GET
/api/v2/order_items/{id}/serial_numbers
List all serial numbers associated with an order item
GetApiV2OrderItemsIdSerialNumbers 1 param → 200401403422
GET
/api/v2/order_items/{id}/wholesale_item
Retrieve the Wholesale item object for an order item
GetApiV2OrderItemsIdWholesaleItem 1 param → 200401403
PUT
/api/v2/order_items/{id}/wholesale_item
Update a wholesale item object
PutApiV2OrderItemsIdWholesaleItem 1 param body → 200401403422

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesOrderItem (31 properties), PutApiV2OrderItemsIdRequest (26 properties), ApiV2EntitiesWholesaleItem (24 properties), PutApiV2OrderItemsIdWholesaleItemRequest (21 properties). Each schema is shown below with its type and property counts.

ApiV2EntitiesSerialNumber
object
5 properties
ApiSharedEntitiesApiError
object
1 property
PutApiV2OrderItemsIdWholesaleItemRequest
object
21 properties
ApiV2EntitiesOriginator
object
18 properties
PutApiV2OrderItemsIdRequest
object
26 properties
ApiV2EntitiesWholesaleItem
object
24 properties
ApiSharedEntitiesMetaFields
object
2 properties
PutApiV2OrderItemsIdCallActionRequest
object
2 properties
ApiV2EntitiesOrderItem
object
31 properties
PutApiV2OrderItemsIdMetaFieldsRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-order-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 items API
Whiplash Merchandising load_scacs API
Whiplash Merchandising notification_events API
Whiplash Merchandising notification_subscriptions API
Whiplash Merchandising order_documents API
Whiplash Merchandising order_totes API
Whiplash Merchandising orders API
Whiplash Merchandising originators API