SellApp for Ruby

Bring your SellApp products into a Ruby app, build a checkout, or connect orders to your existing tools. This SDK is the Ruby library that talks to SellApp's API and turns its responses into typed Ruby objects.

Let's get one product's name into your terminal first. The entire catalog can have its moment once the connection works. Already know the basics? Jump to configuration or the method index.

You need Ruby 3.1 or newer and Bundler. Add the gem to your application's Gemfile:

source "https://rubygems.org"
gem "sellapp", "~> 0.1.1"

Run bundle install from the application directory. Bundler downloads the gem and records the selected versions in Gemfile.lock. For a new application, create a directory and save those two lines as Gemfile first.

You can also install the gem directly with gem install sellapp -v 0.1.1. Browse the RubyGems package or the source repository.

We'll read one product without changing anything in your store. You'll need:

• A secret API key with the listing ability, which allows catalog reads.
• Your store slug: for launch-lab.sell.app, that's launch-lab.

Follow authentication for key setup and access rules. Keep the key on your server and out of Git.

Save this complete program as first-request.rb in your application directory. It loads the gem, creates a client, and asks the products resource for one item:

# frozen_string_literal: true

require "sellapp"

base_url = ENV.fetch("SELLAPP_API_BASE_URL")
raise "Set SELLAPP_API_BASE_URL before running this example" if base_url.empty?

client = SellApp::Client.new(base_url: base_url) # Reads SELLAPP_API_KEY and SELLAPP_STORE.

page = client.products.list(limit: 1)
page.data.each { |product| puts "#{product.id} #{product.title}" }
puts "No products yet. The request worked!" if page.data.empty?

In a Bash-compatible terminal, replace the key and store below, then run the program from that directory. The export lines pass the values to Ruby without storing secrets in the file.

export SELLAPP_API_KEY='replace-with-your-key'
export SELLAPP_STORE='launch-lab'
export SELLAPP_API_BASE_URL='https://sell.app/api'
bundle exec ruby first-request.rb

This endpoint reads your real store. SELLAPP_API_BASE_URL is an example variable passed explicitly to the client, not a built-in SDK setting. Use SELLAPP_STORE consistently across the API guides.

You should see an ID and title from your own store. An empty store prints the success message instead: the connection worked, even if the shelves are bare.

The response's data array holds this page's products. Typed meta and links objects describe the pages around it. Response properties use snake_case; date-time properties remain ISO 8601 strings.

Create a user-owned key in API keys, even before you have a store. Enable account:read for identity, store discovery and permission inspection, and stores:create separately for store creation. Identity, discovery, store detail by ID and creation omit X-STORE; permission inspection and business requests select a store explicitly.

An unrestricted key covers current and future accessible stores. A selected-store key covers only its fixed list; an empty list covers none. Membership and role changes still apply. Selected-store keys cannot create stores. Existing keys do not gain abilities automatically; * satisfies the new abilities while retaining membership, role and restriction checks.

The account guide shows first-store creation, required idempotency keys, and bounded reads across several stores with partial failures. Creation returns an ID and slug; use the slug for subsequent product requests. Find your language's methods in the resource reference. CLI and MCP connections retain browser OAuth.

Keep the request ID when reporting an API failure. Never include credentials.

1. Create and edit a product: exact signatures and complete examples.
2. Read orders or create a checkout: inspect permissions and effects before changing a purchase.
3. Read more than one page: pagination, request controls, errors, and retry behavior.

• Resource reference
• Runnable examples
• API documentation

Find available packages and installation instructions in the SDK guide. Report an SDK issue. Include the SDK version, runtime version, and a redacted reproduction. Licensed under MIT; see third-party notices.