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

(Sandbox Only) Simulate Order and Ship Notice processing, since these are staff-only operations.

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

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

6 operations 6 paths 26 schemas 3 POST3 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 6

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

simulate 6

(Sandbox Only) Simulate Order and Ship Notice processing, since these are staff-only operations.

POST
/api/v2/simulate/consumer_returns/create
Create a consumer return with simulated data
PostApiV2SimulateConsumerReturnsCreate body → 201401403409422
PUT
/api/v2/simulate/consumer_returns/{consumer_return_id}/processing
Simulate processing for an consumer return
PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessing 1 param body → 200401403422
POST
/api/v2/simulate/orders/create
Create an order with simulated data
PostApiV2SimulateOrdersCreate body → 201401403409422
PUT
/api/v2/simulate/orders/{order_id}/processing
Simulate processing for an order
PutApiV2SimulateOrdersOrderIdProcessing 1 param body → 200401403422
POST
/api/v2/simulate/shipnotices/create
Create a shipnotice with simulated data
PostApiV2SimulateShipnoticesCreate body → 201401403409422
PUT
/api/v2/simulate/shipnotices/{shipnotice_id}/processing
Simulate processing for an ship notice
PutApiV2SimulateShipnoticesShipnoticeIdProcessing 1 param body → 200401403422

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are ApiV2EntitiesOrder (126 properties), ApiV2EntitiesCustomer (101 properties), ApiV2EntitiesCustomerShallow (83 properties), ApiV2EntitiesItem (59 properties). Each schema is shown below with its type and property counts.

ApiV2EntitiesCustomer
object
101 properties
ApiV2EntitiesReturnItem
object
16 properties
ApiV2EntitiesWholesaleItem
object
24 properties
ApiV2EntitiesItem
object
59 properties
ApiV2EntitiesConsumerReturn
object
40 properties
ApiV2EntitiesOrder
object
126 properties
ApiV2EntitiesWarehouseShallow
object
46 properties
ApiV2EntitiesWarehouse
object
45 properties
ApiV2EntitiesLot
object
6 properties
ApiV2EntitiesShippingMethod
object
16 properties
ApiV2EntitiesShipnotice
object
54 properties
PutApiV2SimulateOrdersOrderIdProcessingRequest
object
1 property
ApiV2EntitiesShipnoticeItem
object
28 properties
PostApiV2SimulateOrdersCreateRequest
object
1 property
ApiV2EntitiesCustomerShallow
object
83 properties
ApiV2EntitiesOriginator
object
18 properties
ApiV2EntitiesShipnoticeImage
object
5 properties
ApiV2EntitiesWarehouseFeature
object
6 properties
ApiV2EntitiesOrderItem
object
31 properties
PutApiV2SimulateShipnoticesShipnoticeIdProcessingRequest
object
2 properties
PostApiV2SimulateConsumerReturnsCreateRequest
object
1 property
ApiV2EntitiesSerialNumber
object
5 properties
ApiSharedEntitiesApiError
object
1 property
PutApiV2SimulateConsumerReturnsConsumerReturnIdProcessingRequest
object
1 property
ApiV2EntitiesPackage
object
28 properties
PostApiV2SimulateShipnoticesCreateRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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