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

Order processing — full CRUD, bulk creation, actions, customs info, history, documents, items, serial numbers, shipping details, and wholesale

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

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

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

18 operations 16 paths 6 schemas 14 GET3 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 Orders 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 18

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

Orders 18

Order processing — full CRUD, bulk creation, actions, customs info, history, documents, items, serial numbers, shipping details, and wholesale

GET
/v2/orders
List orders
listOrders 2 params → 200401
POST
/v2/orders
Create an order
createOrder body → 201401422
POST
/v2/orders/bulk
Bulk create orders
bulkCreateOrders body → 201401
GET
/v2/orders/count
Count orders
countOrders → 200401
GET
/v2/orders/actions
List available order actions
listOrderActions → 200401
GET
/v2/orders/{id}
Retrieve an order
getOrder 1 param → 200401404
PUT
/v2/orders/{id}
Update an order
updateOrder 1 param body → 200401404
POST
/v2/orders/{id}/call/{action}
Perform an action on an order
performOrderAction 2 params → 200401404
GET
/v2/orders/{id}/customs_info
Get order customs information
getOrderCustomsInfo 1 param → 200401404
GET
/v2/orders/{id}/events
List order events
listOrderEvents 1 param → 200401404
GET
/v2/orders/{id}/events/count
Count order events
countOrderEvents 1 param → 200401
GET
/v2/orders/{id}/order_items
List items in an order
listOrderItems 1 param → 200401
GET
/v2/orders/{id}/order_items/count
Count items in an order
countOrderItems 1 param → 200401
GET
/v2/orders/{id}/serial_numbers
List serial numbers for an order
listOrderSerialNumbers 1 param → 200401
GET
/v2/orders/{id}/order_documents
List documents for an order
listOrderDocuments 1 param → 200401
GET
/v2/orders/{id}/order_documents/count
Count documents for an order
countOrderDocuments 1 param → 200401
GET
/v2/orders/{id}/shipping_documents
List shipping documents for an order
listOrderShippingDocuments 1 param → 200401
GET
/v2/orders/{id}/meta_fields
List meta fields for an order
listOrderMetaFields 1 param → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Order (12 properties), Address (11 properties), OrderInput (7 properties), CustomField (2 properties). Each schema is shown below with its type and property counts.

Order
object
12 properties
ErrorResponse
object
1 property
CustomField
object
2 properties 2 required
CountResponse
object
1 property
Address
object
11 properties
OrderInput
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whiplash-orders-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 Shipnotices API
Whiplash Simulate API