SekoEcomApi

An API wrapper gem for Seko OmniReturns

• OmniReturns

  • Shipment Creation

• OmniParcel

  • Available Rates

Add this line to your application's Gemfile:

gem "seko_ecom_api"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install seko_ecom_api

omni_returns_client = SekoEcomAPI::OmniReturnsClient.new(access_key: ENV['ACCESS_KEY'])

# Create shiment (or label creation)
omni_returns_client.create_shipment(params)

# Params' keys should be in snake case
# For example:
destination = {
	"address" : {
		"building_name" : "",
		"street_address": "123th St",
		"suburb": "Los Angeles",
		"city": "CA",
		"post_code": "90013",
		"country_code": "US"
	}
}

For testing purpose, you will need to set test to true

omni_returns_client = SekoEcomAPI::OmniReturnsClient.new(access_key: ENV['ACCESS_KEY'], test: true)

For error handling, you might encounter SekoEcomAPI::Error and SekoEcomAPI::ParseError

begin
	omni_returns_client.create_shipment(params)
rescue SekoEcomAPI::Error => err
	# The error message should be sufficient enough
rescue SekoEcomAPI::ParseError => err
	# Will be thrown if response's body is not in JSON format
	# Call response.body and response.headers to debug
	puts err.response.body
	puts err.response.headers
end

omni_parcel_client = SekoEcomAPI::OmniParcelClient.new(access_key: ENV['ACCESS_KEY'])

# Retrieve rates
omni_parcel_client.retrieve_rates(params)

For error handle, there will only be SekoEcomAPI::Error with the Validation errors message

begin
  omni_parcel_client.retrieve_rates(params)
rescue SekoEcomAPI::Error => err
end

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/seko_ecom_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the SekoEcomApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.