This is Documentation for the V1 API

V2 API docmentation is located at developers.getwhiplash.com/

Ship Notices

Get a list of Ship Notices

Get a list of all ship notices (incoming shipments of items) for a customer account.

GET https://www.whiplashmerch.com/api/shipnoticesView Response
HTTP/1.1 200 OK
[
  {
    "arrived_at":"2017-05-18T07:36:04-04:00",
    "completed_at":"2017-05-18T07:36:04-04:00",
    "eta":"2017-05-18T07:36:04-04:00",
    "id": 1234,
    "notes_by_customer": null,
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "received_by": "123",
    "sender": "Your Company",
    "status": 300,
    "total_boxes": null,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "Completed",
    "created_at":"2017-05-18T07:36:04-04:00",
    "updated_at":"2017-05-18T07:36:04-04:00",
    "shipnotice_items":[
      {
        "id":58267,
        "item_id":272900,
        "shipnotice_id":1234,
        "available":true,
        "created_at":"2017-05-18T07:38:27-04:00",
        "description":null,
        "extended_description":null,
        "height":"1.0",
        "length":"13.3",
        "quantity":10,
        "quantity_damaged":0,
        "quantity_good":10,
        "updated_at":"2017-05-18T07:38:27-04:00",
        "weight":"7.6",
        "width":"12.0",
        "retail_fee":{"scancoding":"0.1"}
      },
      {
        "id":58268,
        "item_id":272908,
        "shipnotice_id":1234,
        "available":true,
        "created_at":"2017-05-18T07:38:27-04:00",
        "description":null,
        "extended_description":null,
        "height":"1.0",
        "length":"13.3",
        "quantity":10,
        "quantity_damaged":0,
        "quantity_good":10,
        "updated_at":"2017-05-18T07:38:27-04:00",
        "weight":"7.6",
        "width":"12.0",
        "retail_fee":{"scancoding":"0.1"}
      }
    ],
    "shipnotice_images": []
  }
]

Parameters

NameTypeDescription
limit Integer The number of results returned. Default is 50
status Integer/Array Show results matching the specified status(es). You may specify multiple statuses.
offset/page Integer Page to show (defaults to 1)
order_by String Order (defaults to updated_at DESC
since_id Integer Restrict results to after the specified ID
created_at_min Datetime Show results created after date (format: 2008-01-01 03:00)
created_at_max Datetime Show results created before date (format: 2008-01-01 03:00)
updated_at_min Datetime Show results last updated after date (format: 2008-01-01 03:00)
updated_at_max Datetime Show results last updated before date (format: 2008-01-01 03:00)
completed_at_min Datetime Show results completed after date (format: 2008-01-01 03:00)
completed_at_max Datetime Show results completed before date (format: 2008-01-01 03:00)

Shipnotice Count

Get the total number of ship notices for a customer account.

GET https://www.whiplashmerch.com/api/shipnotices/countView Response
HTTP/1.1 200 OK
12335

Parameters

NameTypeDescription
status Integer/Array Show results matching the specified status(es). You may specify multiple statuses.
since_id Integer Restrict results to after the specified ID
created_at_min Datetime Show results created after date (format: 2008-01-01 03:00)
created_at_max Datetime Show results created before date (format: 2008-01-01 03:00)
updated_at_min Datetime Show results last updated after date (format: 2008-01-01 03:00)
updated_at_max Datetime Show results last updated before date (format: 2008-01-01 03:00)
completed_at_min Datetime Show results completed after date (format: 2008-01-01 03:00)
completed_at_max Datetime Show results completed before date (format: 2008-01-01 03:00)

Get a single Ship Notice

GET https://www.whiplashmerch.com/api/shipnotices/{shipnotice-id}View Response
HTTP/1.1 200 OK
{
  "arrived_at":"2017-05-18T07:36:04-04:00",
  "completed_at":"2017-05-18T07:36:04-04:00",
  "eta":"2017-05-18T07:36:04-04:00",
  "id": 1234,
  "notes_by_customer": null,
  "pack_fee_actual": null,
  "pick_fee_actual": null,
  "received_by": "123",
  "sender": "Your Company",
  "status": 300,
  "total_boxes": null,
  "total_fee_actual": null,
  "warehouse_id": 2,
  "status_name": "Completed",
  "created_at":"2017-05-18T07:36:04-04:00",
  "updated_at":"2017-05-18T07:36:04-04:00",
  "shipnotice_items":[
    {
      "id":58267,
      "item_id":272900,
      "shipnotice_id":1234,
      "available":true,
      "created_at":"2017-05-18T07:38:27-04:00",
      "description":null,
      "extended_description":null,
      "height":"1.0",
      "length":"13.3",
      "quantity":10,
      "quantity_damaged":0,
      "quantity_good":10,
      "updated_at":"2017-05-18T07:38:27-04:00",
      "weight":"7.6",
      "width":"12.0",
      "retail_fee":{"scancoding":"0.1"}
    },
    {
      "id":58268,
      "item_id":272908,
      "shipnotice_id":1234,
      "available":true,
      "created_at":"2017-05-18T07:38:27-04:00",
      "description":null,
      "extended_description":null,
      "height":"1.0",
      "length":"13.3",
      "quantity":10,
      "quantity_damaged":0,
      "quantity_good":10,
      "updated_at":"2017-05-18T07:38:27-04:00",
      "weight":"7.6",
      "width":"12.0",
      "retail_fee":{"scancoding":"0.1"}
    }
  ],
  "shipnotice_images": []
}

Create a Ship Notice

POST https://www.whiplashmerch.com/api/shipnoticesView Response
HTTP/1.1 200 OK
{
  "arrived_at":"2017-05-18T07:36:04-04:00",
  "completed_at":"2017-05-18T07:36:04-04:00",
  "eta":"2017-05-18T07:36:04-04:00",
  "id": 1234,
  "notes_by_customer": null,
  "pack_fee_actual": null,
  "pick_fee_actual": null,
  "received_by": "123",
  "sender": "Your Company",
  "status": 300,
  "total_boxes": null,
  "total_fee_actual": null,
  "warehouse_id": 2,
  "status_name": "Completed",
  "created_at":"2017-05-18T07:36:04-04:00",
  "updated_at":"2017-05-18T07:36:04-04:00",
  "shipnotice_items":[
    {
      "id":58267,
      "item_id":272900,
      "shipnotice_id":1234,
      "available":true,
      "created_at":"2017-05-18T07:38:27-04:00",
      "description":null,
      "extended_description":null,
      "height":"1.0",
      "length":"13.3",
      "quantity":10,
      "quantity_damaged":0,
      "quantity_good":10,
      "updated_at":"2017-05-18T07:38:27-04:00",
      "weight":"7.6",
      "width":"12.0",
      "retail_fee":{"scancoding":"0.1"}
    },
    {
      "id":58268,
      "item_id":272908,
      "shipnotice_id":1234,
      "available":true,
      "created_at":"2017-05-18T07:38:27-04:00",
      "description":null,
      "extended_description":null,
      "height":"1.0",
      "length":"13.3",
      "quantity":10,
      "quantity_damaged":0,
      "quantity_good":10,
      "updated_at":"2017-05-18T07:38:27-04:00",
      "weight":"7.6",
      "width":"12.0",
      "retail_fee":{"scancoding":"0.1"}
    }
  ],
  "shipnotice_images": []
}

Parameters

NameTypeDescription
sender String Who we will be receiving the package from (usually your customer name) (required)
eta Datetime When we should expect to receive the shipment (required)
notes_by_customer Text Anything special we should know about receiving the shipment
total_boxes Integer How many boxes should we expect?
warehouse_id Integer Which warehouse are you sending this to? (required)
shipnotice_items Array Which items you're sending us and how many (required)*
shipnotice_images Array Images of the items (optional)

* You should not specify the shipnotice_id in the array of shipnotice_items.

The correct format is: [{"item_id": 1234, "quantity": 50}, {"item_id": 1111, "quantity": 25}].

Update a Ship Notice

Note: You may only update a shipnotice when it has yet to be received (status <= 100).

Note: Once a ship notice is created, you should edit and add ship notice items individually.

PUT https://www.whiplashmerch.com/api/shipnoticesView Response
HTTP/1.1 204 OK

Parameters

NameTypeDescription
sender String Who we will be receiving the package from (usually your customer name)
eta Datetime When we should expect to receive the shipment
notes_by_customer Text Anything special we should know about receiving the shipment
total_boxes Integer How many boxes should we expect?
warehouse_id Integer Which warehouse are you sending this to?
shipnotice_images Array Images of the items (optional)

Delete a Ship Notice

Note: You may only delete a shipnotice when it has yet to be received (status <= 100).

DELETE https://www.whiplashmerch.com/api/shipnoticesView Response
HTTP/1.1 204 OK

Shipnotice Statuses

All ship notices will have one of the following statuses:

CodeName
25Unexpected
50Draft
80Label Purchased
85Refund Expired - Refunded
86Refund Expired - Unrefundable
100In Transit
105Never Received
150Arrived
200Processing
250Problem
300Completed

Warehouse IDs

IDLocation/Name
1Ann Arbor
2San Francisco
3Milton Keynes
4Ypsilanti
5Cypress
6Reno
7SF Dogpatch
8Louisville
9Oakland
10Santa Fe Springs
11Oldsmar
12Toronto
13Wilkes-Barre
14Portland - Swan Island
15Cincinnati
16Union City
17Las Vegas
18Rockwall
19Dallas
20Eliot
21Montreal
22Mira Loma
23Sydney
24Redwood City
25Oyster Point
26Secaucus
27Edison
28Sunnyside Place
29Zurich
30Inglewood
31Burlington
32Chino
33North Vegas
34EDC Dogpatch
35Wilmington
36Peterborough
38Newark, CA
39City of Industry
40City of Industry - BIRD
41Ingleburn, AUS - Sendoso
42Sumner
43Newark, NJ
44Phoenix (temp)
45Sendoso Phoenix
46Rancho
47Sumner - FIGS
48City of Industry - Hedley and Bennett
49Savannah 1
50Carlstadt
51CIty of Industry - Bldg 8
52Columbus 2
53Savannah 2
54Chino - Building 16
55Columbus 2 - Free Fly
56Columbus 3
57Chino - Building 12
58Shoemakersville, PA
59Perris
6014 North
61N Kansas City
62Riverside - 18
63City of Industry - Bldg 10
64Atlanta (Locust Grove)
65Columbus 4