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

Documents are imported files and exported reports. We store a record in your account of every file you import, as well as every report you've run, so they're easy to search and access.

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

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

5 operations 3 paths 3 schemas 1 DELETE3 GET1 POST

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 5

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

documents 5

Documents are imported files and exported reports. We store a record in your account of every file you import, as well as every report you've run, so they're easy to search and ac…

GET
/api/v2/documents
List all documents
GetApiV2Documents 4 params → 200401403
POST
/api/v2/documents
Create a document
PostApiV2Documents body → 201401403409422
GET
/api/v2/documents/actions
List actions you can perform
GetApiV2DocumentsActions → 401403
GET
/api/v2/documents/{id}
Retrieve a document
GetApiV2DocumentsId 1 param → 200401403
DELETE
/api/v2/documents/{id}
Destroy an document
DeleteApiV2DocumentsId 1 param → 204401403422

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesDocument (17 properties), PostApiV2DocumentsRequest (13 properties), ApiSharedEntitiesApiError (1 property). Each schema is shown below with its type and property counts.

ApiSharedEntitiesApiError
object
1 property
PostApiV2DocumentsRequest
object
13 properties
ApiV2EntitiesDocument
object
17 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-merchandising-documents-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 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
Whiplash Merchandising originators API