Skip to content

Latest commit

 

History

History
771 lines (698 loc) · 18.9 KB

README.md

File metadata and controls

771 lines (698 loc) · 18.9 KB
Raw

Weship(io)

That gem provides ruby bindings to weship(ip) API.

Installation

Add this line to your application's Gemfile:

gem 'weship', :git => 'git@github.com:weship/ruby-sdk.git'

And then execute:

$ bundle install

Usage

Weship(io) ruby

All docs are here

Authorization

Obtain API keys here here

w = WeshipClient.new('YOUR_API_KEY')

Address validation

#request
  address = {
    :line1=> "500 S BUENA VISTA ST",
    :city=> "BURBANK",
    :state=> "CA",
    :zip=> "91521",
    :country=> "US",
    :residential=> false,
    :name=> "DONALD DUCK",
    :company=> "DISNEY",
    :phone=> "1234567890",
}

w.validate_address(address)

#response

Packages

Create the package

#request
 package = {
     :title=>"My package", 
     :width=>3, 
     :length=>1, 
     :height=>3
     }

w.create_package(package)

# response

{"package"=>
  {"title"=>"My package",
   "id"=>3,
   "length"=>1,
   "width"=>3,
   "height"=>3,
   "dimension_units"=>"in"},
 "links"=>
  [{"rel"=>"self", "href"=>"http://stage.weship.io/api/v1/packages/3"}]}

Edit the package

#request

 new_package = {
     :title=>"My another new package", 
     :width=>4, 
     :length=>2, 
     :height=>5
     }

w.update_package(1, new_package)

#response

{"package"=>
  {"title"=>"My new package",
   "id"=>3,
   "length"=>2,
   "width"=>4,
   "height"=>5,
   "dimension_units"=>"in"},
 "links"=>
  [{"rel"=>"self", "href"=>"http://stage.weship.io/api/v1/packages/3"}]}

View the packages

#request

w.get_packages_list()

#response

{"items"=>
  [{"title"=>"My new package",
    "id"=>3,
    "length"=>2,
    "width"=>4,
    "height"=>5,
    "dimension_units"=>"in",
    "links"=>
     [{"rel"=>"self", "href"=>"http://stage.weship.io/api/v1/packages/3"}]},
   {"title"=>"My another new package",
    "id"=>3,
    "length"=>2,
    "width"=>4,
    "height"=>5,
    "dimension_units"=>"in",
    "links"=>
     [{"rel"=>"self", "href"=>"http://stage.weship.io/api/v1/packages/4"}]}],
 "meta"=>{"count"=>2}}

View specific package

#request w.show_package(:id)
w.show_package(1)

#response
{"package"=>
  {"title"=>"My new package",
   "id"=>3,
   "length"=>2,
   "width"=>4,
   "height"=>5,
   "dimension_units"=>"in"},
 "links"=>
  [{"rel"=>"self", "href"=>"http://stage.weship.io/api/v1/packages/3"}]}

##Delete the package

#request w.delete_package(:id)
w.delete_package(1)

#response
 => nil

Empty response "204: no content" will be returned

Rates

#request

rates = {
  :from_zip=> "77060",
  :to_zip=> "94040",
  :residential=> true,
  :packages=> [
    {
      :weight=>3,
      :length=>1,
      :width=>1,
      :height=>3
    }
  ]
}

w.get_rates(rates)

#response
[{"rate"=>12.89,
  "carrier"=>{"name"=>"FedEx", "service"=>"ground", "type"=>"WESHIP"},
  "delivery_days"=>3},
 {"rate"=>15.32,
  "carrier"=>{"name"=>"UPS", "service"=>"ground", "type"=>"OWN"},
  "delivery_days"=>4},
 {"rate"=>24.79,
  "carrier"=>{"name"=>"FedEx", "service"=>"3day", "type"=>"WESHIP"},
  "delivery_days"=>3},
 {"rate"=>28.95,
  "carrier"=>{"name"=>"UPS", "service"=>"3day", "type"=>"OWN"},
  "delivery_days"=>3},
 {"rate"=>34.87,
  "carrier"=>{"name"=>"FedEx", "service"=>"2day", "type"=>"WESHIP"},
  "delivery_days"=>2},
 {"rate"=>38.29,
  "carrier"=>{"name"=>"UPS", "service"=>"2day", "type"=>"OWN"},
  "delivery_days"=>2},
 {"rate"=>39.49,
  "carrier"=>{"name"=>"FedEx", "service"=>"2day_morning", "type"=>"WESHIP"},
  "delivery_days"=>2},
 {"rate"=>69.52,
  "carrier"=>{"name"=>"FedEx", "service"=>"1day", "type"=>"WESHIP"},
  "delivery_days"=>1},
 {"rate"=>72.87,
  "carrier"=>{"name"=>"UPS", "service"=>"1day", "type"=>"OWN"},
  "delivery_days"=>1},
 {"rate"=>76.68,
  "carrier"=>{"name"=>"FedEx", "service"=>"1day_morning", "type"=>"WESHIP"},
  "delivery_days"=>1},
 {"rate"=>80.5,
  "carrier"=>{"name"=>"UPS", "service"=>"1day_morning", "type"=>"OWN"},
  "delivery_days"=>1},
 {"rate"=>107.1,
  "carrier"=>
   {"name"=>"FedEx", "service"=>"1day_early_morning", "type"=>"WESHIP"},
  "delivery_days"=>1},
 {"rate"=>113.65,
  "carrier"=>{"name"=>"UPS", "service"=>"1day_early_morning", "type"=>"OWN"},
  "delivery_days"=>1}]

Rates for specific package could be requested

#request
rates_w_my_package = {
 :from_zip=> "77060",
 :to_zip=> "94040",
 :residential=> true,
 :packages=> [
   {
     :weight=>3,
     :length=>1,
     :width=>1,
     :height=>3
   },
   {
     :title=>"My package",
     :weight => 5
   }
 ]
}

w.get_rates(rates_w_my_package)

#response
[{"rate"=>26.37,
 "carrier"=>{"name"=>"FedEx", "service"=>"ground", "type"=>"WESHIP"},
 "delivery_days"=>3},
{"rate"=>33.01,
 "carrier"=>{"name"=>"UPS", "service"=>"ground", "type"=>"OWN"},
 "delivery_days"=>4},
{"rate"=>54.48,
 "carrier"=>{"name"=>"FedEx", "service"=>"3day", "type"=>"WESHIP"},
 "delivery_days"=>3},
{"rate"=>64.48,
 "carrier"=>{"name"=>"UPS", "service"=>"3day", "type"=>"OWN"},
 "delivery_days"=>3},
{"rate"=>77.58,
 "carrier"=>{"name"=>"FedEx", "service"=>"2day", "type"=>"WESHIP"},
 "delivery_days"=>2},
{"rate"=>85.97,
 "carrier"=>{"name"=>"UPS", "service"=>"2day", "type"=>"OWN"},
 "delivery_days"=>2},
{"rate"=>88.07,
 "carrier"=>{"name"=>"FedEx", "service"=>"2day_morning", "type"=>"WESHIP"},
 "delivery_days"=>2},
{"rate"=>149.07,
 "carrier"=>{"name"=>"FedEx", "service"=>"1day", "type"=>"WESHIP"},
 "delivery_days"=>1},
{"rate"=>156.85,
 "carrier"=>{"name"=>"UPS", "service"=>"1day", "type"=>"OWN"},
 "delivery_days"=>1},
{"rate"=>164.0,
 "carrier"=>{"name"=>"FedEx", "service"=>"1day_morning", "type"=>"WESHIP"},
 "delivery_days"=>1},
{"rate"=>172.71,
 "carrier"=>{"name"=>"UPS", "service"=>"1day_morning", "type"=>"OWN"},
 "delivery_days"=>1},
{"rate"=>224.85,
 "carrier"=>
  {"name"=>"FedEx", "service"=>"1day_early_morning", "type"=>"WESHIP"},
 "delivery_days"=>1},
{"rate"=>239.01,
 "carrier"=>{"name"=>"UPS", "service"=>"1day_early_morning", "type"=>"OWN"},
 "delivery_days"=>1}]

#Shipments

Create shipment

#request

shipment = {
    :from=> {
      :line1=> "500 S BUENA VISTA ST",
      :city=> "BURBANK",
      :state=> "CA",
      :zip=> "91521",
      :country=> "US",
      :residential=> false,
      :name=> "DONALD DUCK",
      :company=> "DISNEY",
      :phone=> "1234567890"
    },
    :to=> {
        :line1=> "1515 E BUENA VISTA DR",
        :city=> "LAKE BUENA VISTA",
        :state=> "FL",
        :zip=> "32830",
        :country=> "US",
        :residential=> true,
        :name=> "Receiver name",
        :company=> "DISNEY CASTING CNTR",
        :phone=> "9876543210"
    },
    :package_type=> "box",
    :packages=>[
      {
        :length=>1,
        :width=>1,
        :height=>3,
        :weight=>3.1,
        :insured_value=> "1000"
      }
    ],
    :carrier=> {
      :name=> "FEDEX",
      :service=> "1day",
      :credentials=> "WESHIP"
    },
    :options=> {
      :signature_type=> "adult",
      :label_type=> "pdf",
      :remarks=> "My test shipment",
      :saturday_delivery=> true
      }
    }
    
w.create_shipment(shipment)

#response
{"shipment"=>
  {"id"=>"2751F9E9DB904C738D54FFB59A3D6D70",
   "package_type"=>"box",
   "from"=>
    {"name"=>"DONALD DUCK",
     "company"=>"DISNEY",
     "email"=>nil,
     "phone"=>"1234567890",
     "line1"=>"500 S BUENA VISTA ST",
     "line2"=>nil,
     "city"=>"BURBANK",
     "state"=>"CA",
     "zip"=>"91521",
     "country"=>"US",
     "residential"=>false,
     "_meta"=>{"validated"=>false}},
   "to"=>
    {"name"=>"Receiver name",
     "company"=>"DISNEY CASTING CNTR",
     "email"=>nil,
     "phone"=>"9876543210",
     "line1"=>"1515 E BUENA VISTA DR",
     "line2"=>nil,
     "city"=>"LAKE BUENA VISTA",
     "state"=>"FL",
     "zip"=>"32830",
     "country"=>"US",
     "residential"=>true,
     "_meta"=>{"validated"=>false}},
   "options"=>
    {"signature_type"=>"adult",
     "remarks"=>"My test shipment",
     "saturday_delivery"=>true,
     "label_type"=>"pdf"},
   "packages"=>
    [{"title"=>"CUSTOM",
      "length"=>1.0,
      "width"=>1.0,
      "height"=>3.0,
      "dimension_units"=>"in",
      "weight"=>3.1,
      "weight_units"=>"lb",
      "insured_value"=>1000.0,
      "_meta"=>{"insurance_amount"=>8.35}}],
   "carrier"=>{"name"=>"FEDEX", "service"=>"1day", "credentials"=>"WESHIP"},
   "_meta"=>
    {"status"=>"not_requested",
     "tracking_status"=>{"code"=>"not_tendered", "name"=>"Not tendered"},
     "total_insured_value"=>1000.0,
     "total_insurance_amount"=>8.35,
     "cancellable"=>false,
     "created_at"=>{"datetime"=>"12/16/2013 10:09", "date"=>"12/16/2013"}}},
 "links"=>
  [{"rel"=>"self",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70"},
   {"rel"=>"rates",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/rates"},
   {"rel"=>"track",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/track"}]}

Update the shipment

#request w.update_shipment(:id, params)
shipment_params =   {
    :carrier=> {
      :name=> "UPS",
      :service=> "ground",
      :credentials=> "WESHIP"
    },
    :options=> {
      :signature_type=> "adult",
      :label_type=> "pdf",
      :remarks=> "My test shipment",
      :saturday_delivery=> true
    }
  }
  
w.update_shipment('2751F9E9DB904C738D54FFB59A3D6D70',shipment_params)

#response
{"shipment"=>
  {"id"=>"2751F9E9DB904C738D54FFB59A3D6D70",
   "package_type"=>"box",
   "from"=>
    {"name"=>"DONALD DUCK",
     "company"=>"DISNEY",
     "email"=>nil,
     "phone"=>"1234567890",
     "line1"=>"500 S BUENA VISTA ST",
     "line2"=>nil,
     "city"=>"BURBANK",
     "state"=>"CA",
     "zip"=>"91521",
     "country"=>"US",
     "residential"=>false,
     "_meta"=>{"validated"=>false}},
   "to"=>
    {"name"=>"Receiver name",
     "company"=>"DISNEY CASTING CNTR",
     "email"=>nil,
     "phone"=>"9876543210",
     "line1"=>"1515 E BUENA VISTA DR",
     "line2"=>nil,
     "city"=>"LAKE BUENA VISTA",
     "state"=>"FL",
     "zip"=>"32830",
     "country"=>"US",
     "residential"=>true,
     "_meta"=>{"validated"=>false}},
   "options"=>
    {"signature_type"=>"adult",
     "remarks"=>"My test shipment",
     "saturday_delivery"=>true,
     "label_type"=>"pdf"},
   "packages"=>
    [{"title"=>"CUSTOM",
      "length"=>1.0,
      "width"=>1.0,
      "height"=>3.0,
      "dimension_units"=>"in",
      "weight"=>3.1,
      "weight_units"=>"lb",
      "insured_value"=>1000.0,
      "_meta"=>{"insurance_amount"=>8.35}}],
   "carrier"=>{"name"=>"UPS", "service"=>"ground", "credentials"=>"WESHIP"},
   "_meta"=>
    {"total_signature_amount"=>4.5,
     "status"=>"not_requested",
     "tracking_status"=>{"code"=>"not_tendered", "name"=>"Not tendered"},
     "total_insured_value"=>1000.0,
     "total_insurance_amount"=>8.35,
     "cancellable"=>false,
     "created_at"=>{"datetime"=>"12/16/2013 10:09", "date"=>"12/16/2013"}}},
 "links"=>
  [{"rel"=>"self",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70"},
   {"rel"=>"rates",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/rates"},
   {"rel"=>"track",
    "href"=>
     "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/track"}]}

View shipments list

#request
w.get_shipments_list()

#response
{"items"=>
  [{"id"=>"2751F9E9DB904C738D54FFB59A3D6D70",
    "package_type"=>"box",
    "from"=>
     {"name"=>"DONALD DUCK",
      "company"=>"DISNEY",
      "email"=>nil,
      "phone"=>"1234567890",
      "line1"=>"500 S BUENA VISTA ST",
      "line2"=>nil,
      "city"=>"BURBANK",
      "state"=>"CA",
      "zip"=>"91521",
      "country"=>"US",
      "residential"=>false,
      "_meta"=>{"validated"=>false}},
    "to"=>
     {"name"=>"Receiver name",
      "company"=>"DISNEY CASTING CNTR",
      "email"=>nil,
      "phone"=>"9876543210",
      "line1"=>"1515 E BUENA VISTA DR",
      "line2"=>nil,
      "city"=>"LAKE BUENA VISTA",
      "state"=>"FL",
      "zip"=>"32830",
      "country"=>"US",
      "residential"=>true,
      "_meta"=>{"validated"=>false}},
    "options"=>
     {"signature_type"=>"adult",
      "remarks"=>"My test shipment",
      "saturday_delivery"=>true,
      "label_type"=>"pdf"},
    "packages"=>
     [{"title"=>"CUSTOM",
       "length"=>1.0,
       "width"=>1.0,
       "height"=>3.0,
       "dimension_units"=>"in",
       "weight"=>3.1,
       "weight_units"=>"lb",
       "insured_value"=>1000.0,
       "_meta"=>{"insurance_amount"=>8.35}}],
    "carrier"=>{"name"=>"UPS", "service"=>"ground", "credentials"=>"WESHIP"},
    "_meta"=>
     {"total_signature_amount"=>4.5,
      "status"=>"not_requested",
      "tracking_status"=>{"code"=>"not_tendered", "name"=>"Not tendered"},
      "total_insured_value"=>1000.0,
      "total_insurance_amount"=>8.35,
      "cancellable"=>false,
      "created_at"=>{"datetime"=>"12/16/2013 10:09", "date"=>"12/16/2013"}},
    "links"=>
     [{"rel"=>"self",
       "href"=>
        "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70"},
      {"rel"=>"rates",
       "href"=>
        "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/rates"},
      {"rel"=>"track",
       "href"=>
        "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/track"}]},
   ,
   ...
 "meta"=>{"count"=>8}}

View specific shipment

#request w.get_shipment(:id)
w.get_shipment('2751F9E9DB904C738D54FFB59A3D6D70')

#response
{"shipment"=>
 {"id"=>"2751F9E9DB904C738D54FFB59A3D6D70",
  "package_type"=>"box",
  "from"=>
   {"name"=>"DONALD DUCK",
    "company"=>"DISNEY",
    "email"=>nil,
    "phone"=>"1234567890",
    "line1"=>"500 S BUENA VISTA ST",
    "line2"=>nil,
    "city"=>"BURBANK",
    "state"=>"CA",
    "zip"=>"91521",
    "country"=>"US",
    "residential"=>false,
    "_meta"=>{"validated"=>false}},
  "to"=>
   {"name"=>"Receiver name",
    "company"=>"DISNEY CASTING CNTR",
    "email"=>nil,
    "phone"=>"9876543210",
    "line1"=>"1515 E BUENA VISTA DR",
    "line2"=>nil,
    "city"=>"LAKE BUENA VISTA",
    "state"=>"FL",
    "zip"=>"32830",
    "country"=>"US",
    "residential"=>true,
    "_meta"=>{"validated"=>false}},
  "options"=>
   {"signature_type"=>"adult",
    "remarks"=>"My test shipment",
    "saturday_delivery"=>true,
    "label_type"=>"pdf"},
  "packages"=>
   [{"title"=>"CUSTOM",
     "length"=>1.0,
     "width"=>1.0,
     "height"=>3.0,
     "dimension_units"=>"in",
     "weight"=>3.1,
     "weight_units"=>"lb",
     "insured_value"=>1000.0,
     "_meta"=>{"insurance_amount"=>8.35}}],
  "carrier"=>{"name"=>"UPS", "service"=>"ground", "credentials"=>"WESHIP"},
  "_meta"=>
   {"total_signature_amount"=>4.5,
    "status"=>"not_requested",
    "tracking_status"=>{"code"=>"not_tendered", "name"=>"Not tendered"},
    "total_insured_value"=>1000.0,
    "total_insurance_amount"=>8.35,
    "cancellable"=>false,
    "created_at"=>{"datetime"=>"12/16/2013 10:09", "date"=>"12/16/2013"}}},
"links"=>
 [{"rel"=>"self",
   "href"=>
    "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70"},
  {"rel"=>"rates",
   "href"=>
    "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/rates"},
  {"rel"=>"track",
   "href"=>
    "http://stage.weship.io/api/v1/shipments/2751F9E9DB904C738D54FFB59A3D6D70/track"}]}

Get shipment rates

#request w.get_shipment_rates(:id)
w.get_shipment_rates('2751F9E9DB904C738D54FFB59A3D6D70')

#response
{"items"=>
  [{"rate"=>27.49,
    "carrier"=>{"name"=>"FedEx", "service"=>"ground", "type"=>"WESHIP"},
    "delivery_days"=>4},
   {"rate"=>30.56,
    "carrier"=>{"name"=>"UPS", "service"=>"ground", "type"=>"OWN"},
    "delivery_days"=>4},
   {"rate"=>45.23,
    "carrier"=>{"name"=>"FedEx", "service"=>"3day", "type"=>"WESHIP"},
    "delivery_days"=>3},
   {"rate"=>47.66,
    "carrier"=>{"name"=>"UPS", "service"=>"3day", "type"=>"OWN"},
    "delivery_days"=>3},
   {"rate"=>53.56,
    "carrier"=>{"name"=>"FedEx", "service"=>"2day", "type"=>"WESHIP"},
    "delivery_days"=>2},
   {"rate"=>57.33,
    "carrier"=>{"name"=>"UPS", "service"=>"2day", "type"=>"OWN"},
    "delivery_days"=>2},
   {"rate"=>59.0,
    "carrier"=>{"name"=>"FedEx", "service"=>"2day_morning", "type"=>"WESHIP"},
    "delivery_days"=>2},
   {"rate"=>94.9,
    "carrier"=>{"name"=>"UPS", "service"=>"1day", "type"=>"OWN"},
    "delivery_days"=>1},
   {"rate"=>99.48,
    "carrier"=>{"name"=>"FedEx", "service"=>"1day_morning", "type"=>"WESHIP"},
    "delivery_days"=>1},
   {"rate"=>103.46,
    "carrier"=>{"name"=>"UPS", "service"=>"1day_morning", "type"=>"OWN"},
    "delivery_days"=>1},
   {"rate"=>129.9,
    "carrier"=>
     {"name"=>"FedEx", "service"=>"1day_early_morning", "type"=>"WESHIP"},
    "delivery_days"=>1},
   {"rate"=>136.61,
    "carrier"=>{"name"=>"UPS", "service"=>"1day_early_morning", "type"=>"OWN"},
    "delivery_days"=>1}],
 "meta"=>{"count"=>12}}

Purchase the shipment

#request w.buy_shipment(:id)

w.buy_shipment('E10C9D74F9AC4359B8AC2920BEE99448')

#response
{:labels=>
  [{:tracking_number=>"794827603007",
    :label_file=>
     "https://stage.weship.io/api/v1/packages/518FF3154AB149F8AE41AF1B15A5C79F/label"},
   {:tracking_number=>"794827603040",
    :label_file=>
     "https://stage.weship.io/api/v1/packages/8215AEB4C67C4C0D8C197C48CDEF5883/label"}]}

One request shipment purchase

#request
shipment = {:from=>
  {:line1=>"500 S BUENA VISTA ST",
   :city=>"BURBANK",
   :state=>"CA",
   :zip=>"91521",
   :country=>"US",
   :residential=>false,
   :name=>"DONALD DUCK",
   :company=>"DISNEY",
   :phone=>"1234567890"},
 :to=>
  {:line1=>"1515 E BUENA VISTA DR",
   :city=>"LAKE BUENA VISTA",
   :state=>"FL",
   :zip=>"32830",
   :country=>"US",
   :residential=>true,
   :name=>"Receiver name",
   :company=>"DISNEY CASTING CNTR",
   :phone=>"9876543210"},
 :package_type=>"box",
 :packages=>
  [{:length=>1, :width=>1, :height=>3, :weight=>3.1, :insured_value=>"1000"}],
 :carrier=>{:name=>"UPS", :service=>"1day", :credentials=>"WESHIP"},
 :options=>{:remarks=>"My test shipment"}}

w.purchase_shipment(shipment)

#response
{"labels"=>
  [{"tracking_number"=>"1Z426F0W1393884237",
    "label_file"=>
     "http://stage.weship.io/api/v1/packages/2495D7F779C544C798B68C73F8AED4CE/label"}]}
 => {"labels"=>[{"tracking_number"=>"1Z426F0W1393884237", "label_file"=>"http://stage.weship.io/api/v1/packages/2495D7F779C544C798B68C73F8AED4CE/label"}]}

Track the shipment

#request
track = {
  :carrier=> "FEDEX",
  :tracking_number=> "440719515003652"
}

w.track_shipment(track)

#response
{"tracking"=>
  {"ed_time"=>nil,
   "status"=>"not_tendered",
   "carrier"=>"FEDEX",
   "tracking_history"=>[]}}

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request