How to Use Shopify API to Manage Products in Ruby

Initialization and Setup

• Install the Shopify API gem in your Ruby application by executing the following command in your terminal:

gem install shopify_api

• In your Ruby application, require the Shopify API gem and establish a session to begin interacting with the API. Use the following code snippet to set up the session:

require 'shopify_api'

ShopifyAPI::Base.site = 'https://your_store.myshopify.com/admin/api/2023-10'
ShopifyAPI::Base.api_version = '2023-10'
ShopifyAPI::Base.headers['X-Shopify-Access-Token'] = 'your-access-token'

Fetching Products

• Retrieve a list of all products using the Shopify API. Execute the following code to fetch and display product details:

products = ShopifyAPI::Product.find(:all)
products.each do |product|
  puts "#{product.title} - #{product.id}"
end

Creating a New Product

• Create new products by constructing a product object and saving it to your store via the API. Use the code below for creating a product:

new_product = ShopifyAPI::Product.new(
  title: "New Product",
  body_html: "<strong>Amazing product</strong>",
  vendor: "Vendor Name",
  product_type: "Category Name"
)

if new_product.save
  puts "Product successfully created with ID: #{new_product.id}"
else
  puts "Failed to create product."
end

Updating an Existing Product

• Modify existing products by fetching and updating the product object. Refer to the following code to update a product's title:

product = ShopifyAPI::Product.find(existing_product_id)
product.title = "Updated Product Title"

if product.save
  puts "Product updated successfully."
else
  puts "Failed to update product."
end

Deleting a Product

• Remove a product from your store by calling the destroy method on a product object. Use this example to delete a product:

product = ShopifyAPI::Product.find(existing_product_id)

if product.destroy
  puts "Product deleted successfully."
else
  puts "Failed to delete product."
end

Error Handling and Response Management

• Implement error handling to manage exceptions and API response errors. Here's an example of basic error handling:

begin
  new_product.save!
  puts "Product created successfully."
rescue ActiveResource::ResourceInvalid => e
  puts "Failed: #{e.message}"
end

• Use logging to track errors and exceptions for better diagnostics and debugging.

Conclusion

• Using the Shopify API in Ruby allows for robust product management in your Shopify store.
• Advance further by exploring additional features of the API such as inventory, orders, and webhooks.