This is Documentation for the V1 API

V2 API docmentation is located at

The Whiplash V1 API.

Using the Whiplash API you can create an application to do any task you would normally do on For example, you could use the API to get a list of all orders that have been shipped recently, change order addresses before they've gone out, create new orders and more.

The Whiplash API is implemented as JSON or XML over HTTP using all four verbs (GET/POST/PUT/DELETE). Each resource, like Order, Item, etc., has its own endpoints.


The most common type of integration is notifying Whiplash of an order that needs to ship. In that scenario, there are four basic steps to cover:

  1. Authenticate your connection
  2. Create an Item, which represents a product in a specific size, style and color
  3. Create an Order, which contains the address and shipping method
  4. Create an OrderItem, which references both the Order and the Item, telling Whiplash what product to ship.

Note that your implentation of each of these steps should check for the existence of the Whiplash object prior to your application creating it. Item, for example, is created once and shared by many orders.

Pro Tip: You can save your own order ID as @order.originator_id which will make it easier to look up your orders later. Using the Originator ID will also act as a safeguard to prevent your application from creating multiple copies of the same order.


An authentification token is required for all API requests. It should be included in an X-API-KEY header.

Your API key is available on your preferences page.


The current version of the Whiplash API is 1. You may optionally specify which API version you'd like in an X-API-VERSION header (if, for instance, you wanted to continue to use an older API version when a new one is released). The default API version will always be the most recent, though users would typically be notified with a new API version release. Newly added features or endpoints to any given API version will be backward compatible.

Testing Environment

We provide a testing server at

You can test things out with our shared Sandbox customer account, using authentication key kQmwEGWwPRtzEQzSeCvG, or you can e-mail us for your own test account.


The following endpoints are currently supported:

API Libraries

There are a number of libraries allowing you to easily connect to the Whiplash API.