This is Documentation for the V1 API
V2 API docmentation is located at developers.getwhiplash.com/
Get a list of all ship notices (incoming shipments of items) for a customer account.
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": [] } ]
Name | Type | Description |
---|---|---|
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) |
Get the total number of ship notices for a customer account.
HTTP/1.1 200 OK 12335
Name | Type | Description |
---|---|---|
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) |
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": [] }
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": [] }
Name | Type | Description |
---|---|---|
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}]
.
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.
HTTP/1.1 204 OK
Name | Type | Description |
---|---|---|
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) |
Note: You may only delete a shipnotice when it has yet to be received (status <= 100).
HTTP/1.1 204 OK
All ship notices will have one of the following statuses:
Code | Name |
---|---|
25 | Unexpected |
50 | Draft |
80 | Label Purchased |
85 | Refund Expired - Refunded |
86 | Refund Expired - Unrefundable |
100 | In Transit |
105 | Never Received |
150 | Arrived |
200 | Processing |
250 | Problem |
300 | Completed |
ID | Location/Name |
---|---|
1 | Ann Arbor |
2 | San Francisco |
3 | Milton Keynes |
4 | Ypsilanti |
5 | Cypress |
6 | Reno |
7 | SF Dogpatch |
8 | Louisville |
9 | Oakland |
10 | Santa Fe Springs |
11 | Oldsmar |
12 | Toronto |
13 | Wilkes-Barre |
14 | Portland - Swan Island |
15 | Cincinnati |
16 | Union City |
17 | Las Vegas |
18 | Rockwall |
19 | Dallas |
20 | Eliot |
21 | Montreal |
22 | Mira Loma |
23 | Sydney |
24 | Redwood City |
25 | Oyster Point |
26 | Secaucus |
27 | Edison |
28 | Sunnyside Place |
29 | Zurich |
30 | Inglewood |
31 | Burlington |
32 | Chino |
33 | North Vegas |
34 | EDC Dogpatch |
35 | Wilmington |
36 | Peterborough |
38 | Newark, CA |
39 | City of Industry |
40 | City of Industry - BIRD |
41 | Ingleburn, AUS - Sendoso |
42 | Sumner |
43 | Newark, NJ |
44 | Phoenix (temp) |
45 | Sendoso Phoenix |
46 | Rancho |
47 | Sumner - FIGS |
48 | City of Industry - Hedley and Bennett |
49 | Savannah 1 |
50 | Carlstadt |
51 | CIty of Industry - Bldg 8 |
52 | Columbus 2 |
53 | Savannah 2 |
54 | Chino - Building 16 |
55 | Columbus 2 - Free Fly |
56 | Columbus 3 |
57 | Chino - Building 12 |
58 | Shoemakersville, PA |
59 | Perris |
60 | 14 North |
61 | N Kansas City |
62 | Riverside - 18 |
63 | City of Industry - Bldg 10 |
64 | Atlanta (Locust Grove) |
65 | Columbus 4 |