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

Similar to an OrderItem, ShipnoticeItem represents an Item with a quantity in a Shipnotice. quantity refers to the quantity expected to arrive, and the quantity actually received is quantity_good.

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

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

7 operations 4 paths 8 schemas 1 DELETE4 GET2 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 7

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

shipnotice_items 7

Similar to an OrderItem, ShipnoticeItem represents an Item with a quantity in a Shipnotice. quantity refers to the quantity expected to arrive, and the quantity actually received…

GET
/api/v2/shipnotice_items/actions
List actions you can perform
GetApiV2ShipnoticeItemsActions → 401403
GET
/api/v2/shipnotice_items/count
Count ship notice items
GetApiV2ShipnoticeItemsCount 1 param → 200401403
GET
/api/v2/shipnotice_items/{id}
Retrieve a ship notice item
GetApiV2ShipnoticeItemsId 1 param → 200401403
PUT
/api/v2/shipnotice_items/{id}
Update a ship notice item
PutApiV2ShipnoticeItemsId 1 param body → 200401403422
DELETE
/api/v2/shipnotice_items/{id}
Destroy a shipnotice item
DeleteApiV2ShipnoticeItemsId 1 param → 204401403422
GET
/api/v2/shipnotice_items/{id}/meta_fields
List meta fields
GetApiV2ShipnoticeItemsIdMetaFields 2 params → 200401403
PUT
/api/v2/shipnotice_items/{id}/meta_fields
Set meta fields
PutApiV2ShipnoticeItemsIdMetaFields 1 param body → 204401403422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesItem (59 properties), ApiV2EntitiesShipnoticeItem (28 properties), PutApiV2ShipnoticeItemsIdRequest (7 properties), ApiV2EntitiesLot (6 properties). Each schema is shown below with its type and property counts.

ApiSharedEntitiesApiError
object
1 property
PutApiV2ShipnoticeItemsIdMetaFieldsRequest
object
2 properties
ApiV2EntitiesCount
object
1 property
ApiSharedEntitiesMetaFields
object
2 properties
ApiV2EntitiesLot
object
6 properties
ApiV2EntitiesItem
object
59 properties
ApiV2EntitiesShipnoticeItem
object
28 properties
PutApiV2ShipnoticeItemsIdRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-shipnotice-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_items API
Whiplash Merchandising order_totes API
Whiplash Merchandising orders API