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

A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse.Shipnotices represent incoming stock.

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

This API exposes 14 operations across 9 paths, and defines 19 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.

14 operations 9 paths 19 schemas 1 DELETE8 GET3 POST2 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 14

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

shipnotices 14

A Shipnotice is the opposite of an order, and are notifications by the client of inventory that is expected to arrive at a warehouse. Shipnotices represent incoming stock.

GET
/api/v2/shipnotices
List all ship notices
GetApiV2Shipnotices 7 params → 200401403
POST
/api/v2/shipnotices
Create a ship notice
PostApiV2Shipnotices body → 201401403409422
GET
/api/v2/shipnotices/actions
List actions you can perform
GetApiV2ShipnoticesActions → 401403
POST
/api/v2/shipnotices/bulk
Create shipnotices in bulk
PostApiV2ShipnoticesBulk body → 201401403409422
GET
/api/v2/shipnotices/count
Count ship notices
GetApiV2ShipnoticesCount 1 param → 200401403
GET
/api/v2/shipnotices/{id}
Retrieve a ship notice
GetApiV2ShipnoticesId 1 param → 200401403
PUT
/api/v2/shipnotices/{id}
Update a ship notice
PutApiV2ShipnoticesId 1 param body → 200401403422
DELETE
/api/v2/shipnotices/{id}
Destroy a ship notice
DeleteApiV2ShipnoticesId 1 param → 204401403422
GET
/api/v2/shipnotices/{id}/meta_fields
List meta fields
GetApiV2ShipnoticesIdMetaFields 2 params → 200401403
PUT
/api/v2/shipnotices/{id}/meta_fields
Set meta fields
PutApiV2ShipnoticesIdMetaFields 1 param body → 204401403422
GET
/api/v2/shipnotices/{id}/orders_waiting
Count orders waiting for stock in a ship notice
GetApiV2ShipnoticesIdOrdersWaiting 1 param → 200401403
GET
/api/v2/shipnotices/{id}/shipnotice_items
List associated ship notice items
GetApiV2ShipnoticesIdShipnoticeItems 8 params → 200401403
POST
/api/v2/shipnotices/{id}/shipnotice_items
Create a ship notice item
PostApiV2ShipnoticesIdShipnoticeItems 1 param body → 201401403409422
GET
/api/v2/shipnotices/{id}/shipnotice_items/count
Count associated ship notice items
GetApiV2ShipnoticesIdShipnoticeItemsCount 2 params → 200401403

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesCustomer (101 properties), ApiV2EntitiesItem (59 properties), ApiV2EntitiesShipnotice (54 properties), ApiV2EntitiesWarehouse (45 properties). Each schema is shown below with its type and property counts.

ApiV2EntitiesCustomer
object
101 properties
ApiSharedEntitiesMetaFields
object
2 properties
ApiV2EntitiesItem
object
59 properties
ApiV2EntitiesWarehouse
object
45 properties
ApiV2EntitiesCount
object
1 property
ApiV2EntitiesLot
object
6 properties
ApiV2EntitiesShippingMethod
object
16 properties
ApiV2EntitiesShipnotice
object
54 properties
ApiV2EntitiesResult
object
1 property
ApiV2EntitiesShipnoticeItem
object
28 properties
PostApiV2ShipnoticesBulkRequest
object
1 property 1 required
ApiV2EntitiesShipnoticeImage
object
5 properties
ApiV2EntitiesOriginator
object
18 properties
ApiV2EntitiesWarehouseFeature
object
6 properties
PostApiV2ShipnoticesRequest
object
42 properties 3 required
ApiSharedEntitiesApiError
object
1 property
PutApiV2ShipnoticesIdMetaFieldsRequest
object
2 properties
PutApiV2ShipnoticesIdRequest
object
37 properties
PostApiV2ShipnoticesIdShipnoticeItemsRequest
object
12 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-shipnotices-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