This is Documentation for the V1 API

V2 API docmentation is located at docs.getwhiplash.com/api

Ship Notice Items

Get a list of Ship Notice Items for a Ship Notice

Given a Ship Notice ID, get a list of shipnotice items.

GET https://www.whiplashmerch.com/api/shipnotice_items?shipnotice_id={shipnotice-id}View Response
HTTP/1.1 200 OK
[
  {
    "id":58267,
    "item_id":272900,
    "shipnotice_id":17211,
    "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"}
  }
]

Parameters

NameTypeDescription
limit Integer The number of results returned. Default is 50
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)

Get a single shipnotice item

GET https://www.whiplashmerch.com/api/shipnotice_items/{shipnotice-item-id}View Response
HTTP/1.1 200 OK
{
  "id":58267,
  "item_id":272900,
  "shipnotice_id":17211,
  "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"}
}

Create a shipnotice item

Note: You can only create shipnotice items for ship notices which have yet to be received (status <= 100).

POST https://www.whiplashmerch.com/api/shipnotice_itemsView Response
HTTP/1.1 200 OK
{
  "id":58267,
  "item_id":272900,
  "shipnotice_id":17211,
  "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"
}

Parameters

NameTypeDescription
shipnotice_id Integer The shipnotice this ship notice item belongs to (required)
item_id Integer The item associated with this ship notice item (required)
quantity Integer Number of this item in the order (required)
available Boolean Should we process orders for this item? (default is true)

Update a shipnotice item

Note: You can only update shipnotice items for ship notices which have yet to be received (status <= 100).

PUT https://www.whiplashmerch.com/api/shipnotice_items/{shipnotice-item-id}View Response
HTTP/1.1 204 OK

Parameters

NameTypeDescription
shipnotice_id Integer The shipnotice this shipnotice item belongs to
item_id Integer The item associated with this shipnotice item
quantity Integer Number of this item in the order
available Boolean Should we process orders for this item?

Delete a shipnotice item

Note: You can only delete shipnotice items for ship notices which have yet to be received (status <= 100).

DELETE https://www.whiplashmerch.com/api/shipnotice_items/{shipnotice-item-id}View Response
HTTP/1.1 204 OK