Inventory API Ruby client
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


InventoryClient - the Ruby gem for the InventoryAPI

Orkiv Inventory API client

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-08-05T15:21:23.297-04:00
  • Build package: class io.swagger.codegen.languages.RubyClientCodegen


Build a gem

To build the Ruby code into a gem:

gem build InventoryClient.gemspec

Then either install the gem locally:

gem install ./InventoryClient-1.0.0.gem

(for development, run gem install --dev ./InventoryClient-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'InventoryClient', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository:, then add the following in the Gemfile:

gem 'InventoryClient', :git => ''

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'InventoryClient'

# Setup authorization
InventoryClient.configure do |config|
  # Configure API key authorization: APIKey
  config.api_key['APIKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['APIKey'] = 'Bearer'

  # Configure API key authorization: AccountID
  config.api_key['accountid'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['accountid'] = 'Bearer'

api_instance =

  result = api_instance.all_get
  p result
rescue InventoryClient::ApiError => e
  puts "Exception when calling DefaultApi->all_get: #{e}"

Documentation for API Endpoints

All URIs are relative to

Class Method HTTP request Description
InventoryClient::DefaultApi all_get GET /all/
InventoryClient::DefaultApi categories_delete DELETE /categories/
InventoryClient::DefaultApi categories_post POST /categories/
InventoryClient::DefaultApi categories_put PUT /categories/
InventoryClient::DefaultApi item_add_post POST /item/add/
InventoryClient::DefaultApi item_addbulk_post POST /item/addbulk/
InventoryClient::DefaultApi item_delete DELETE /item/
InventoryClient::DefaultApi item_get GET /item/
InventoryClient::DefaultApi item_media_delete DELETE /item-media/
InventoryClient::DefaultApi item_media_post POST /item-media/
InventoryClient::DefaultApi item_put PUT /item/
InventoryClient::DefaultApi items_count_post POST /items/count/
InventoryClient::DefaultApi items_post POST /items/
InventoryClient::DefaultApi orders_post POST /orders/
InventoryClient::DefaultApi orders_services_post POST /orders/services/
InventoryClient::DefaultApi query_post POST /query/
InventoryClient::DefaultApi services_delete DELETE /services/
InventoryClient::DefaultApi services_get GET /services/
InventoryClient::DefaultApi services_open_get GET /services/open/
InventoryClient::DefaultApi services_post POST /services/
InventoryClient::DefaultApi services_put PUT /services/
InventoryClient::DefaultApi variation_delete DELETE /variation/
InventoryClient::DefaultApi variation_get GET /variation/
InventoryClient::DefaultApi variation_post POST /variation/
InventoryClient::DefaultApi variation_put PUT /variation/
InventoryClient::DefaultApi write_delete DELETE /write/
InventoryClient::DefaultApi write_post POST /write/

Documentation for Models

Documentation for Authorization


  • Type: API key
  • API key parameter name: APIKey
  • Location: HTTP header


  • Type: API key
  • API key parameter name: accountid
  • Location: HTTP header