NAV

The Whiplash API

Using the Whiplash API you can create an application to do any task you would normally do on GetWhiplash.com
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.

Overview

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/item ID as 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/item.

Versioning

Whiplash offers two versions of our API:

  1. The v1 API offers limited endpoints, but is full-featured enough for most integrations. It uses standard token authentication, using your customer API key. 
  2. The v2 API is very comprehensive, but requires Oauth authentication. v2 access is currently by request only

You may optionally specify which API version you'd like in an X-API-VERSION header. The default API version is currently 1.
New features/endpoints will only be added to the v2 API.

Testing Environment

We provide a testing server at https://sandbox.getwhiplash.com.

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.

Learn more about testing the v2 API.

API Libraries

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

Additional Resources


Last updated Jul 11th, 2018