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

Simulation endpoints for testing order, consumer return, and shipnotice processing in sandbox environments

Whiplash Simulate API is one of 10 APIs that Whiplash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Simulate. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 6 operations across 6 paths. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.getwhiplash.com.

6 operations 6 paths 0 schemas 6 POST

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 Simulate 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 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

Simulate 6

Simulation endpoints for testing order, consumer return, and shipnotice processing in sandbox environments

POST
/v2/simulate/orders/create
Simulate order creation
simulateCreateOrder → 201401
POST
/v2/simulate/orders/{order_id}/process
Simulate order processing
simulateProcessOrder 1 param → 200401
POST
/v2/simulate/consumer_returns/create
Simulate consumer return creation
simulateCreateConsumerReturn → 201401
POST
/v2/simulate/consumer_returns/{consumer_return_id}/process
Simulate consumer return processing
simulateProcessConsumerReturn 1 param → 200401
POST
/v2/simulate/shipnotices/create
Simulate shipnotice creation
simulateCreateShipnotice → 201401
POST
/v2/simulate/shipnotices/{shipnotice_id}/process
Simulate shipnotice processing
simulateProcessShipnotice 1 param → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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