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": Wed, 29 Apr 2015 17:21:03 EDT -04:00,
    "completed_at": Thu, 30 Apr 2015 16:37:32 EDT -04:00,
    "eta": Fri, 01 May 2015 00:00:00 EDT -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",
    "shipnotice_items":
    [
     {
       "available": true,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": 1,
       "id": 1234,
       "item_id": 12345,
       "length": 13,
       "quantity": 10,
       "quantity_damaged": 0,
       "quantity_good": 10,
       "shipnotice_id": 17211,
       "updated_at": Wed, 29 Apr 2015 19:24:14 EDT -04:00,
       "weight": 7.6,
       "width": 12
      },
      {
       "available": true,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": 1,
       "id": 1235,
       "item_id": 12346,
       "length": 11,
       "quantity": 15,
       "quantity_damaged": 0,
       "quantity_good": 15,
       "shipnotice_id": 17211,
       "updated_at": Wed, 29 Apr 2015 19:26:32 EDT -04:00,
       "weight": 7.4,
       "width": 12,
      }
    ],
    "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": Wed, 29 Apr 2015 17:21:03 EDT -04:00,
    "completed_at": Thu, 30 Apr 2015 16:37:32 EDT -04:00,
    "eta": Fri, 01 May 2015 00:00:00 EDT -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",
    "shipnotice_items":
    [
     {
       "available": true,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": 1,
       "id": 1234,
       "item_id": 12345,
       "length": 13,
       "quantity": 10,
       "quantity_damaged": 0,
       "quantity_good": 10,
       "shipnotice_id": 17211,
       "updated_at": Wed, 29 Apr 2015 19:24:14 EDT -04:00,
       "weight": 7.6,
       "width": 12
      },
      {
       "available": true,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": 1,
       "id": 1235,
       "item_id": 12346,
       "length": 11,
       "quantity": 15,
       "quantity_damaged": 0,
       "quantity_good": 15,
       "shipnotice_id": 17211,
       "updated_at": Wed, 29 Apr 2015 19:26:32 EDT -04:00,
       "weight": 7.4,
       "width": 12,
      }
    ],
    "shipnotice_images": []
  }

Create a Ship Notice

POST https://www.whiplashmerch.com/api/shipnoticesView Response
HTTP/1.1 200 OK
  {
    "arrived_at": null,
    "completed_at": null,
    "eta": Fri, 01 May 2015 00:00:00 EDT -04:00,
    "id": 1234,
    "notes_by_customer": "Here are some special notes about this shipment",
    "pack_fee_actual": null,
    "pick_fee_actual": null,
    "received_by": "123",
    "sender": "Your Company",
    "status": 100,
    "total_boxes": 1,
    "total_fee_actual": null,
    "warehouse_id": 2,
    "status_name": "In transit",
    "shipnotice_items":
    [
     {
       "available": true,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": null,
       "id": 1234,
       "item_id": 12345,
       "length": null,
       "quantity": 10,
       "quantity_damaged": 0,
       "quantity_good": 10,
       "shipnotice_id": 17211,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "updated_at": Wed, 29 Apr 2015 19:24:14 EDT -04:00,
       "weight": null,
       "width": null
      },
      {
       "available": true,
       "description": null,
       "extended_description": null,
       "fee": null,
       "height": null,
       "id": 1235,
       "item_id": 12346,
       "length": null,
       "quantity": 15,
       "quantity_damaged": 0,
       "quantity_good": 15,
       "shipnotice_id": 17211,
       "created_at": Tue, 28 Apr 2015 20:34:03 EDT -04:00,
       "updated_at": Wed, 29 Apr 2015 19:26:32 EDT -04:00,
       "weight": null,
       "width": null,
      }
    ],
    "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
100In Transit
150Arrived
200Processing
250Problem
300Completed

Warehouse IDs

IDLocation/Name
1Ann Arbor
2San Francisco
3London
4Ypsilanti
5Cypress
6Reno
7SF Dogpatch
8Louisville
9Oakland
10Sante Fe Springs
11Oldsmar
12Toronto
13Wilkes-Barre
14Portland - Swan Island
15Cincinnati
16Union City
17Las Vegas
18Rockwall
19Dallas
20Eliot
21Montreal
22Mira Loma
Whiplash_partner_program Warehouse with extra capacity? Checkout our Partner Program