Unleashed

A Ruby wrapper for Unleashed

Check out example app here and example app repo here.

The documentation for Unleashed API can be found here

This library supports the following resources:

• SalesOrders

Add this line to your application's Gemfile:

gem 'unleashed_client'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install unleashed_client

Before you can use the gem, you will have to register and get your API key and API ID. Check out Unleashed get started page for more information.

Set your API_KEY and API_ID as your environment variables. If you're managing your environment variables dotenv add API_KEY=your_key and API_ID=your_id to your .env file, or if you're using something like Figaro set your API_KEY: your_key and your API_ID: your_id.

require 'unleashed_client'

@client = UnleashedClient::SalesOrder.new(api_key: ENV['API_KEY'], api_id: ENV['API_ID'])

This is useful if you need to iterate over all pages and get all the data:

pages = @client.get_number_of_pages

Returns the first 200 sales orders because page number 1 is the default:

items = @client.get_first_200

your_page_number = 2

items = @client.get_orders_from_page(page_number: your_page_number)

Example usage: You can combine get_orders_from_page with get_number_of_pages. This will allow you to loop through all available pages and get the data (for example, if you are creating records in your local database):

require 'unleashed_client'

@client = UnleashedClient::SalesOrder.new(api_key: ENV['API_KEY'], api_id: ENV['API_ID'])

number_of_pages = @client.get_number_of_pages

number_of_pages.downto(1).each do |i|
    items = @client.get_orders_from_page(page_number: i)
    # do stuff with items
end

Returns details of a particular sales order using sales order guid value (ex guid: E6E8163F-6911-40e9-B740-90E5A0A3A996)

your_guid = "E6E8163F-6911-40e9-B740-90E5A0A3A996"
response = @client.get_details(guid: your_guid)

# response["Guid"] => "E6E8163F-6911-40e9-B740-90E5A0A3A996"
# response["OrderNumber"] => "SO-xxx"
# ...

• Add better tests wth Rspec;
• Let users pick returned data type between JSON and Xml;

What has to be added for SalesOrders resource:

• creating new sales orders;
• complete a sales order;
• update a sales order;

Other resources to be added:

• Customers;
• Products;
• PurchaseOrders;
• SalesPersons;
• SalesPersons;
• SalesShipments;
• StockAdjustments;
• WarehouseStockTransfers;

• Marko Manojlovic marko.manojlovic.bg@gmail.com
• https://manoylo.me
• LinkedIn