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

Incoming inventory shipments — list, create, bulk operations, count, retrieve, update, destroy, items, and meta fields

Whiplash Shipnotices API is one of 10 APIs that Whiplash 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, authentication docs, and rate-limit docs.

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

11 operations 8 paths 2 schemas 1 DELETE7 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.getwhiplash.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Whiplash Shipnotices 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 11

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

Shipnotices 11

Incoming inventory shipments — list, create, bulk operations, count, retrieve, update, destroy, items, and meta fields

GET
/v2/shipnotices
List shipnotices
listShipnotices 2 params → 200401
POST
/v2/shipnotices
Create a shipnotice
createShipnotice body → 201401422
POST
/v2/shipnotices/bulk
Bulk create shipnotices
bulkCreateShipnotices body → 201401
GET
/v2/shipnotices/count
Count shipnotices
countShipnotices → 200401
GET
/v2/shipnotices/actions
List available shipnotice actions
listShipnoticeActions → 200401
GET
/v2/shipnotices/{id}
Retrieve a shipnotice
getShipnotice 1 param → 200401404
PUT
/v2/shipnotices/{id}
Update a shipnotice
updateShipnotice 1 param body → 200401404
DELETE
/v2/shipnotices/{id}
Delete a shipnotice
deleteShipnotice 1 param → 204401404
GET
/v2/shipnotices/{id}/shipnotice_items
List items in a shipnotice
listShipnoticeItems 1 param → 200401
GET
/v2/shipnotices/{id}/shipnotice_items/count
Count items in a shipnotice
countShipnoticeItems 1 param → 200401
GET
/v2/shipnotices/{id}/meta_fields
List meta fields for a shipnotice
listShipnoticeMetaFields 1 param → 200401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CountResponse (1 property), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property
CountResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-shipnotices-api-openapi.yml Raw ↑

Other APIs Whiplash publishes across the network.

Whiplash Bundle Items API
Whiplash Consumer Returns API
Whiplash Customers API
Whiplash Documents API
Whiplash Items API
Whiplash Notification Events API
Whiplash Notification Subscriptions API
Whiplash Orders API
Whiplash Simulate API