3plCentral

A Ruby wrapper for the 3PL Central SOAP API.

3PL Central is a SaaS WMS. Read more here at http://www.3plcentral.com/

View the 3PL API Documentation here: https://app02.3plcentral.com/webserviceexternal/contracts.asmx

Installation

Add this line to your application's Gemfile:

gem '3pl_central'

And then execute:

$ bundle

Or install it yourself as:

$ gem install 3pl_central

Usage

Per Usage Configuration

This method works indentically to the other, it just makes it easier to deal with different customer records, usernames, IDs, etc. that you might have in 3PL Central.

client = ThreePLCentral::Client.new(three_pl_key: "{a123457-a389-4674-bcdd-a646150aaf}", login: "3pluser"  , password: "3plpass", three_pl_id: "123")

client.create_order(params_for_order_create)

client.find_order(params_for_find_order)

client.find_small_parcel_order(params_for_shipment)

client.get_stock_status(params_for_stock_status)

Per Application Configuration

  require '3pl_central'

  ThreePLCentral.configure do |c|
    c.three_pl_key        = "{YOUR GUID GOES HERE}"
    c.login               = "customer_login" #configured in 3PL Central -> Customer -> Customer Users
    c.password            = "customer_password" # same as login
    c.default_facility_id = 1 #this might be removed in a later version, and we'll just look for the "Facility ID" on the order or item level.
    # c.user_login_id       = 4 #We had to contact our account manager with 3PL Central to get this information.
    c.customer_id         = 1

    # three_pl_id is for reading, three_pl_key is for writing
    c.three_pl_id         = "three_pl_id"

    # Pass configuration values to Savon
    # See values in Savon documentation
    c.savon_config        = {
      log: false
    }
  end

Creating Orders

#assuming configuration was already done...

ThreePLCentral::Order.create({
  trans_info: {
    reference_num: "100001",  # required
    expected_date: "2014-11-12",
    earliest_ship_date: "2014-11-12",
    ship_cancel_date:  "2014-11-12"},
  ship_to: {
    name: "Test Test",
    company_name: "Test Co.",  # required
    address:{
      address1: "Toronto",  # required
      address2:"Ste. 2",
      city:"1234 Fake St.",  # required
      state:"ON",  # required
      zip:"M4B 1B3",  # required
      country:"Canada"  # required
    },
    phone_number1: "999-999-9999",
    email_address1: "test@test.com",
  },
  shipping_instructions: {
    carrier: "FedEx",  # required
    mode: "Ground",  # required
    billing_code: "Prepaid"  # required
    shipping_notes: "I need it ASAP!"},
  notes: "More notes!",
  order_line_items: [  # required at least one
    # NOTE: This is an array of hashes, each hash only contain one key:
    # `order_line_item`
    { order_line_item:
      {
        SKU:"90RND-010101", # It must be all uppercase, required
        qty:"10",  # required
        fulfillment_sale_price:9.99,
        fulfillment_discount_percentage:10,
        fulfillment_discount_amount:0.99
      }
      # ... more objects(items) here
    }
  ],
  fulfillment_info:{
    fulfill_inv_shipping_and_handling:9.12,
    fulfill_inv_tax:0.49},
  sold_to: {
    name:"Joe Jones",
    address:{
      address1:"5555 Some Pl.",
      city:"Portland",
      state:"OR",
      zip:"97219",
      country:"United States"},
    phone_number1:"503-992-2329",
    email_address1:"joe.jones@example.com"}
})

# => true

TODOs

Move the credentials to a "per request" basis, rather than being configured for the entire instance of the gem, in our integration we'll use this to separate out to different (3PL Central) customers that we're interacting with.
Write tests, there aren't any done currently. However there's not a whole lot of logic either.
Expose configuration of Savon gem. Currently the defaults we set aren't changeable, and Savon is going to be spitting out a fair amount of debugging information.
Fix Guardfile, it only seems to generate documentation currently, not run the specs.
Wrap other functionality, an observant user might notice that only part of the 3PL Central web service is wrapped, that's because we just did what we needed for our specific implementation.
Document more examples, we should have a working example for each of the services that are wrapped.

Contributing

Fork it ( https://github.com/adamrunner/3pl_central/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

nurelm/3pl_central