OmniShip

Currently Supported Calls

• Tracking Url -> auto detects the provider based on the format of the tracking number works with UPS, USPS, DHL, DHL Global Mail, FedEx, Landmark Global

• Track -> auto detects the provider based on the format of the tracking number

• UPS and UPS Mail Innovations

  • Track

• Landmark Global

  • Landmark
    • Track
    • Track with reference

• USPS

  • Track
  • Return label

• DHL Global Mail

  • Track Usage

---

Require the library:

require 'rubygems'
require 'omniship'

Set authentication details; you only need the details for services you'll be using; tracking url stuff doesn't need any authentications

OmniShip::UPS.username = 'johndoe'
OmniShip::UPS.password = '1234567890'
OmniShip::UPS.token = 'QWERTYUIOP'

OmniShip::USPS.userid = 'johndoe'
OmniShip::USPS.password = '1234567890'

OmniShip::Landmark.username = 'johndoe'
OmniShip::Landmark.password = '1234567890'
OmniShip::Landmark.client_id = '123'
OmniShip::Landmark.test_mode = true # this turns Landmark's test mode on

OmniShip::DHLGM.username = 'johndoe'
OmniShip::DHLGM.password = '1234567890'
OmniShip::DHLGM.mailer_id = '1234567890' # this is required to detect the shipper type, since USPS and DHL are otherwise indistinguisiblle

OmniShip.debug = true # with this enabled all xml request's and responses will be outputed to the log

You can also do this in a config file
config/settings.yaml


OmniShip:
  debug: true
  
  USPS:
    userid: johndoe
    password: 1234567890
    client_ip: 127.0.0.1
    source_id: Wantable, Inc. 

    retailer:
      name: Wantable 
      address: 223 N Water St. STE 300
    permit:
      number: 1234
      city: Milwaukee
      state: WI
      zip5: 53202
    pdu:
      po_box: 223 N Water ST STE 300
      city: Milwaukee 
      state: WI 
      zip5: 53202

  UPS:
    username: johndoe
    password: 1234567890

  Landmark:
    username: johndoe
    password: 1234567890
    client_id: 123
    debug: true


  DHLGM:
    username: johndoe
    password: 1234567890


and then set it up in an intializer like: 

    OmniShip.config('config/settings.yml')

UPS

Track a package by tracking number:

trk = OmniShip::UPS.track('1z3050790327433970')

The result:

trk.class
# => OmniShip::UPS::TrackResponse

trk.shipment.class
# => OmniShip::UPS::Track::Shipment

trk.shipment.scheduled_delivery
# => Mon Nov 29 12:00:00 UTC 2010

trk.shipment.packages.first.has_left?
# => true / false

trk.shipment.packages.first.has_arrived?
# => true / false

trk.shipment.packages.first.tracking_number
# => "1z3050790327433970" 

USPS

Track a package by tracking number:

trk = OmniShip::USPS.track('9400111201080302430600')

The result:

trk.class
# => OmniShip::USPS::TrackResponse

trk.shipment.class
# => OmniShip::USPS::Track::Shipment

trk.shipment.scheduled_delivery
# => Mon Nov 29 12:00:00 UTC 2010

trk.shipment.packages.first.has_left?
# => true / false

trk.shipment.packages.first.has_arrived?
# => true / false

trk.shipment.packages.first.tracking_number
# => "1z3050790327433970" 

Make a return shipping label

• In order to use this USPS api you need to first obtain "Merchandise Return Service Permit"; directions for that are here in the section labeled "Obtain a Merchandise Return Service Permit"

• You can get a userid and password here but you need to call them at 1-800-344-7779 and have them activate it for the production server. The api doesn't seem to work with the test server at all; but they'll activate you no questions asked in like a 30 second phone call.

    customer = {
        :name => "Casey Juan Lopez", 
        :address1 => "223 N Water St.", 
        :address2 => "STE 300", 
        :city => "Milwaukee",
        :state => "WI",
        :zip5 => "53202"
    }
    options = {
        :window => "RIGHTWINDOW", 
        :service_type => "PRIORITY", 
        :delivery_confirmation => false, 
        :insurance_value => nil,  # only applicable if delivery_confirmation = true
        :weight => "13", # in ounces 
        :image_type => "TIF", #TIF/PDF 
        :rma => "asdfghjkl", 
        :rma_barcode => true,
    }
  
    label = OmniShip::USPS.return_label(customer, options)
    label.tracking_number
    # => "420532029311769932000000144614" 
  
    label.save("label_file")
    # creates file label_file.tif
  

Landmark Global

trk = OmniShip::Landmark.track('LTN64365934N1')

also equivalent to

trk = OmniShip::Landmark.track_with_reference('REFID')

The result:

trk.class
# => OmniShip::Landmark::TrackResponse

trk.shipment.class
# => OmniShip::Landmark::Track::Shipment

trk.shipment.scheduled_delivery
# => Mon Nov 29 12:00:00 UTC 2010

trk.shipment.packages.first.has_left?
# => true / false

trk.shipment.packages.first.has_arrived?
# => true / false

trk.shipment.packages.first.tracking_number
# => "LTN62075201N1" 

DHLGM

trk = OmniShip::DHLGM.track('12345')

The result:

trk.class
# => OmniShip::DHLGM::TrackResponse

trk.shipment.class
# => OmniShip::DHLGM::Track::Shipment

trk.shipment.scheduled_delivery - not supported by DHL Global Mail
# => nil

trk.shipment.packages.first.has_left?
# => true / false

trk.shipment.packages.first.has_arrived?
# => true / false

You can also track it if you don't know what provider it is (currently supports UPS, USPS, Landmark, and DHL Global Mail[only if mailer_id configured and matches])

trk = OmniShip.track('LTN64365934N1')

The result:

trk.class
# => OmniShip::Landmark::TrackResponse

....

Build the url to view tracking information from the tracking number (currently supports UPS, USPS, DHL, DHL Global Mail, FedEx, Landmark Global)

OmniShip.tracking_url('1z3050790327433970')
# => "http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1z3050790327433970"