API (2.1)

Download OpenAPI specification:Download

Whiplash Development Team: tech@getwhiplash.com URL: https://www.getwhiplash.com

The Whiplash V2 API is open by invite only. Fill out request form here

Authentication

whiplash_auth

The Whiplash V2 API uses Oauth2 for authorization.
Find more info about how to authenticate to Whiplash via Oauth2 here.

Security Scheme Type OAuth2
implicit OAuth Flow
Authorization URL: /oauth/token
Scopes:
  • user_read -

    read user information, default scope if none is provided

  • user_manage -

    modify user information

  • app_read -

    read application information

  • app_manage -

    read application information

  • app_create_user -

    create users for the application

items

Items are probably the most fundamental entity in the Whiplash system. An item is simply a 'shippable unit'. So, it's not a Whiplash T-Shirt; it's a Small Whiplash T-Shirt, for instance.

Most commerce platforms model Products. Typically, however, a Product (e.g. a T-Shirt) has variations (named variously, Variants, ProductOptions, OptionSets, etc). An Item maps to the Variant/Option, not the Product.

Create an item

header Parameters
X-Customer-Id
string

The customer associated with this resource.

X-Shop-Id
string

The shop associated with this resource.

Request Body schema: application/x-www-form-urlencoded
sku
string

the item SKU number

title
string

the item title

description
string

the item description

full_description
string

the full item description

original_location
string

the original warehouse location for the item

customer_id
integer <int32>

the id of the customer the item belongs to

weight
number <float>

the weight of the item (in pounds)

available
boolean

is the item available?

image_originator_url
string

the originator url for the item image

vendor
string

the item vendor

scancode
string

the item scancode

price
number <float>

the item price

media_mail
boolean

is the item eligible for media mail?

packaging
boolean

is the item packaging?

length
number <float>

the item length (in inches)

width
number <float>

the item width (in inches)

height
number <float>

the item height (in inches)

active
boolean

is the item active?

wholesale_cost
number <float>

the wholesale cost of the item

is_bundle
boolean

is the item a bundle?

packaging_type
string
Enum: "Card" "Letter" "Flat" "Parcel" "LargeParcel" "IrregularParcel" "FlatRateEnvelope" "FlatRateLegalEnvelope" "FlatRatePaddedEnvelope" "FlatRateGiftCardEnvelope" "FlatRateWindowEnvelope" "FlatRateCardboardEnvelope" "SmallFlatRateEnvelope" "SmallFlatRateBox" "MediumFlatRateBox" "LargeFlatRateBox" "RegionalRateBoxA" "RegionalRateBoxB" "RegionalRateBoxC" "LargeFlatRateBoardGameBox" "UPSLetter" "UPSExpressBox" "UPS25kgBox" "UPS10kgBox" "Tube" "Pak" "Pallet" "SmallExpressBox" "MediumExpressBox" "LargeExpressBox" "FedExEnvelope" "FedExBox" "FedExPak" "FedExTube" "FedEx10kgBox" "FedEx25kgBox" "Letter" "Flat" "BPM" "Parcel" "Letter" "LargeLetter" "SmallParcel" "MediumParcel" "WhiplashBag" "WhiplashBox" "WhiplashBubbleMailer" "WhiplashFill" "WhiplashFlat" "WhiplashTube" "WhiplashNoPackaging"

the item packaging type

promo
boolean

is the item a promo?

street_date
string <date-time>

the item street date

category
string

the item category

include_inbound_in_published
boolean

include inbound items in published?

returnable
boolean

is the item returnable?

return_sku_match
string

the item return SKU match