Vtex API client ruby implementation

Add this line to your application's Gemfile:

gem 'vtex'

And then execute:

$ bundle

Or install it yourself as:

$ gem install vtex

You'll need to gatter the following information from your VTex account

• X-VTEX-API-AppKey

  Email from a user with access to the API.

• X-VTEX-API-AppToken

  VTEXId password of the user with access to the API.

• Account name

  VTex account name.

• Environment:

  • Use vtexcommercestable for production
  • Use vtexcommmercebeta for tests

Note: It's recommended that you create an specific user to access the API (vtex-auth)

With all the information retrieve a client instance with it.

client = Vtex::Client.new({ account_name: "demo",
                            environment: "vtexcommercebeta",
                            app_key: "api.user@email.com",
                            app_token: "VTEXIdPassword" })

VTex follows a design of resources as methods on the client. For example, for Products, you will call your client like this:

client = Vtex::Client.new({ ... })
client.products #=> ProductsResource

VTex will return PORO objects that contain the information provided by the API. For example:

client.products.by_id(id: 1)
# => Vtex::Product (Id:1, Name: "Guarda-Roupa Casal Lisboa 10 Portas 3 Gavetas - Araplac", ...)

Note: Right now, Key Values are being used as they come from the API

All resources, methods and properties are direct matches from the VTex API

Vtex API: Catalog System - Product

Usage:

client = Vtex::Client.new({ ... })
client.product #=> ProductResource

Actions supported:

• client.product.product_by_id(id: 'id')
• client.product.product_by_ref_id(ref_id: 'ref_id')
• client.product.product_variations(product_id: 'product_id')
• client.product.review_rate_product

Vtex API: Catalog System - Category

Usage:

client = Vtex::Client.new({ ... })
client.category_and_brand #=> CategoryAndBrandResource

Actions supported:

• client.category_and_brand.category(id: 'id')
• client.category_and_brand.category_tree(levels: 'number of levels')
• client.category_and_brand.brand

Vtex API: Catalog System - Indexer, Notification and AutoComplete

Usage:

client = Vtex::Client.new({ ... })
client.indexer_notification_and_autocomplete #=> IndexerNotificationAndAutocompleteResource

Actions supported:

• client.indexer_notification_and_autocomplete.change_notification
• client.indexer_notification_and_autocomplete.indexed_info

Vtex API: Catalog System - Sales Channel

Usage:

client = Vtex::Client.new({ ... })
client.sales_channel #=> SalesChannelResource

Actions supported:

• client.sales_channel.sales_channel_list
• client.sales_channel.sales_channel_by_id(sales_channel_id: 'sales_channel_id')

Vtex API: Catalog System - Seller

Usage:

client = Vtex::Client.new({ ... })
client.seller #=> SellerResource

Actions supported:

• client.seller.seller_list
• client.seller.get_seller(seller_id: 'seller_id')

Vtex API: Catalog System - Sku

Usage:

client = Vtex::Client.new({ ... })
client.sku #=> SkuResource

Actions supported:

• client.sku.sku(sku_id: 'sku_id')
• client.sku.sku_id_by_ref_id(ref_id: 'ref_id')
• client.sku.sku_by_ean(ean: 'ean')
• client.sku.sku_by_alternate_id(ean: 'ean')
• client.sku.sku_list_by_product_id(product_id: 'product_id')

Vtex API: Catalog System - Specification

Usage:

client = Vtex::Client.new({ ... })
client.specification #=> SpecificationResource

Actions supported:

• client.specification.specification_by_category_id(category_id: 'category_id')
• client.specification.specification_tree_by_category_id(category_id: 'category_id')
• client.specification.specification_value_by_field_id(field_id: 'field_id')
• client.specification.specification_field(field_id: 'field_id')

After 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.

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 tags, and push the .gem file to rubygems.org.

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

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

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