{"id":19777994,"url":"https://github.com/virolea/zoho_inventory","last_synced_at":"2025-06-20T16:09:35.044Z","repository":{"id":48763630,"uuid":"158855835","full_name":"virolea/zoho_inventory","owner":"virolea","description":"Ruby wrapper for the Zoho Inventory API","archived":false,"fork":false,"pushed_at":"2022-10-06T03:36:52.000Z","size":39,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T12:21:43.280Z","etag":null,"topics":["api","gem","ruby","zoho","zoho-inventory"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/virolea.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-23T16:29:21.000Z","updated_at":"2021-01-22T00:15:09.000Z","dependencies_parsed_at":"2023-01-19T08:45:46.033Z","dependency_job_id":null,"html_url":"https://github.com/virolea/zoho_inventory","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/virolea/zoho_inventory","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virolea%2Fzoho_inventory","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virolea%2Fzoho_inventory/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virolea%2Fzoho_inventory/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virolea%2Fzoho_inventory/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/virolea","download_url":"https://codeload.github.com/virolea/zoho_inventory/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virolea%2Fzoho_inventory/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260976720,"owners_count":23091507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","gem","ruby","zoho","zoho-inventory"],"created_at":"2024-11-12T05:27:24.014Z","updated_at":"2025-06-20T16:09:30.035Z","avatar_url":"https://github.com/virolea.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/Virolea/zoho_inventory.svg?branch=master)](https://travis-ci.org/Virolea/zoho_inventory) [![Test Coverage](https://api.codeclimate.com/v1/badges/47c8158aec1128ce892d/test_coverage)](https://codeclimate.com/github/Virolea/zoho_inventory/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/47c8158aec1128ce892d/maintainability)](https://codeclimate.com/github/Virolea/zoho_inventory/maintainability)\n\n⚠️  This is a work in progress, only CRUD operations are available for Zoho models for now, and models will be added gradually.\n\n# ZohoInventory\n\nThis gem is a wrapper for the Zoho Inventory API.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'zoho_inventory'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install zoho_inventory\n\n## Usage\n\n### Authentication\n\nIn order to authenticate to the Zoho Inventory API, do the following:\n\n```ruby\nZohoInventory.auth_token = \"REPLACE_WITH_YOUR_AUTH_TOKEN\"\nZohoInventory.organization_id = \"REPLACE_WITH_YOUR_ORGANIZATION_ID\"\n```\n\n### Errors\n\nEvery API call that result in an error from zoho will result in a `ZohoError` exception thrown.\n\n```ruby\nbegin\n  # Zoho API Call\n  ZohoInventory::Item.retrieve(\"item_id\")\nrescue ZohoError =\u003e e\n  # Exception thrown\n  puts e.message\nend\n```\n\n### CRUD Operaions\n\nThe gem implements all CRUD operations available to the different Zoho models. [More info on available operations here](https://www.zoho.com/inventory/api/v1/)\n\nFor example, with items:\n\n```ruby\n# Create an item\nZohoInventory::Item.create({ name: \"Death Star\", ... })\n\n# List all items\nZohoInventory::Item.list\n\n# Retrieve an item\nZohoInventory::Item.retrieve(item_id)\n\n# Update an item\nZohoInventory::Item.update(item_id, { name: \"X-Wing\", ... })\n\n# Delete an item\nZohoInventory::Item.delete(item_id)\n```\n\nThe Zoho models avaiable in the gem are: `organizations`, `items`, `users`, `invoices` and `contacts`.\n\nSpecial model-specific actions such as `mark_as_active` will be added once all model CRUD actions are implemented. It will be documented below\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/Virolea/zoho_inventory. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the ZohoInventory project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/zoho_inventory/blob/master/CODE_OF_CONDUCT.md).\n\n\n## Contact\n\nPing me on [Twitter](https://twitter.com/V_Rolea) for any question!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirolea%2Fzoho_inventory","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirolea%2Fzoho_inventory","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirolea%2Fzoho_inventory/lists"}