module Shiphawk::Api::Shipments

Shipments API

@see shiphawk.com/api-docs

The following API actions provide the CRUD interface to managing Shipments.

Public Instance Methods

shipments_bol(shipment_id) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 20
def shipments_bol shipment_id
  get_request shipments_path("#{shipment_id}/bol"), {}
end
shipments_bol_pdf(shipment_id) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 24
def shipments_bol_pdf shipment_id
  get_request shipments_path("#{shipment_id}/bol.pdf"), {}
end
shipments_create(options) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 28
def shipments_create options
  post_request shipments_path, options
end
shipments_destroy(shipment_id) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 36
def shipments_destroy shipment_id
  delete_request shipments_path(shipment_id), {}
end
shipments_index() click to toggle source
# File lib/shiphawk/api/shipments.rb, line 12
def shipments_index
  collection_request shipments_path, 500
end
shipments_show(shipment_id) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 16
def shipments_show shipment_id
  entity_request_with_id shipments_path, shipment_id
end
shipments_update(shipment_id, options) click to toggle source
# File lib/shiphawk/api/shipments.rb, line 32
def shipments_update shipment_id, options
  put_request shipments_path(shipment_id), options
end