gem.sh gem.sh
Home Gems Types Docs Community
  • Modules

    • module ShopifyAPI
    • module ShopifyAPI::AdminVersions
    • module ShopifyAPI::Auth
    • module ShopifyAPI::Auth::ClientCredentials
    • module ShopifyAPI::Auth::Oauth
    • module ShopifyAPI::Auth::RefreshToken
    • module ShopifyAPI::Auth::TokenExchange
    • module ShopifyAPI::Clients
    • module ShopifyAPI::Clients::Graphql
    • module ShopifyAPI::Clients::Rest
    • module ShopifyAPI::Errors
    • module ShopifyAPI::Rest
    • module ShopifyAPI::Utils
    • module ShopifyAPI::Utils::AttributesComparator
    • module ShopifyAPI::Utils::GraphqlProxy
    • module ShopifyAPI::Utils::HmacValidator
    • module ShopifyAPI::Utils::HttpUtils
    • module ShopifyAPI::Utils::VerifiableQuery
    • module ShopifyAPI::Webhooks
    • module ShopifyAPI::Webhooks::Registrations
    • module ShopifyAPI::Webhooks::WebhookHandler
  • Classes

    • class ShopifyAPI::AbandonedCheckout
    • class ShopifyAPI::AccessScope
    • class ShopifyAPI::AndroidPayKey
    • class ShopifyAPI::ApplePayCertificate
    • class ShopifyAPI::ApplicationCharge
    • class ShopifyAPI::ApplicationCredit
    • class ShopifyAPI::Article
    • class ShopifyAPI::Asset
    • class ShopifyAPI::AssignedFulfillmentOrder
    • class ShopifyAPI::Auth::AssociatedUser
    • class ShopifyAPI::Auth::AuthScopes
    • class ShopifyAPI::Auth::JwtPayload
    • class ShopifyAPI::Auth::Oauth::AccessTokenResponse
    • class ShopifyAPI::Auth::Oauth::AuthQuery
    • class ShopifyAPI::Auth::Oauth::SessionCookie
    • class ShopifyAPI::Auth::Session
    • class ShopifyAPI::Auth::TokenExchange::RequestedTokenType
    • class ShopifyAPI::Balance
    • class ShopifyAPI::Blog
    • class ShopifyAPI::CancellationRequest
    • class ShopifyAPI::CarrierService
    • class ShopifyAPI::Checkout
    • class ShopifyAPI::Clients::Graphql::Admin
    • class ShopifyAPI::Clients::Graphql::Client
    • class ShopifyAPI::Clients::Graphql::Storefront
    • class ShopifyAPI::Clients::HttpClient
    • class ShopifyAPI::Clients::HttpRequest
    • class ShopifyAPI::Clients::HttpResponse
    • class ShopifyAPI::Clients::Rest::Admin
    • class ShopifyAPI::Collect
    • class ShopifyAPI::Collection
    • class ShopifyAPI::CollectionListing
    • class ShopifyAPI::Comment
    • class ShopifyAPI::Context
    • class ShopifyAPI::Country
    • class ShopifyAPI::Currency
    • class ShopifyAPI::CustomCollection
    • class ShopifyAPI::Customer
    • class ShopifyAPI::CustomerAddress
    • class ShopifyAPI::CustomerSavedSearch
    • class ShopifyAPI::DeprecatedApiCall
    • class ShopifyAPI::DiscountCode
    • class ShopifyAPI::Dispute
    • class ShopifyAPI::DisputeEvidence
    • class ShopifyAPI::DisputeFileUpload
    • class ShopifyAPI::DraftOrder
    • class ShopifyAPI::Errors::ContextNotSetupError
    • class ShopifyAPI::Errors::CookieNotFoundError
    • class ShopifyAPI::Errors::DisabledResourceError
    • class ShopifyAPI::Errors::FeatureDeprecatedError
    • class ShopifyAPI::Errors::HttpResponseError
    • class ShopifyAPI::Errors::InvalidGraphqlRequestError
    • class ShopifyAPI::Errors::InvalidHttpRequestError
    • class ShopifyAPI::Errors::InvalidJwtTokenError
    • class ShopifyAPI::Errors::InvalidOauthError
    • class ShopifyAPI::Errors::InvalidWebhookError
    • class ShopifyAPI::Errors::InvalidWebhookRegistrationError
    • class ShopifyAPI::Errors::LogLevelNotFoundError
    • class ShopifyAPI::Errors::MaxHttpRetriesExceededError
    • class ShopifyAPI::Errors::MissingJwtTokenError
    • class ShopifyAPI::Errors::MissingRequiredArgumentError
    • class ShopifyAPI::Errors::NoActiveSessionError
    • class ShopifyAPI::Errors::NoSessionCookieError
    • class ShopifyAPI::Errors::NoWebhookHandler
    • class ShopifyAPI::Errors::PrivateAppError
    • class ShopifyAPI::Errors::RequestAccessTokenError
    • class ShopifyAPI::Errors::SessionNotFoundError
    • class ShopifyAPI::Errors::SessionStorageError
    • class ShopifyAPI::Errors::UnsupportedOauthError
    • class ShopifyAPI::Errors::UnsupportedVersionError
    • class ShopifyAPI::Errors::WebhookRegistrationError
    • class ShopifyAPI::Event
    • class ShopifyAPI::Fulfillment
    • class ShopifyAPI::FulfillmentEvent
    • class ShopifyAPI::FulfillmentOrder
    • class ShopifyAPI::FulfillmentRequest
    • class ShopifyAPI::FulfillmentService
    • class ShopifyAPI::GiftCard
    • class ShopifyAPI::GiftCardAdjustment
    • class ShopifyAPI::Image
    • class ShopifyAPI::Inflector
    • class ShopifyAPI::InventoryItem
    • class ShopifyAPI::InventoryLevel
    • class ShopifyAPI::Location
    • class ShopifyAPI::LocationsForMove
    • class ShopifyAPI::Logger
    • class ShopifyAPI::MarketingEvent
    • class ShopifyAPI::Metafield
    • class ShopifyAPI::MobilePlatformApplication
    • class ShopifyAPI::Order
    • class ShopifyAPI::OrderRisk
    • class ShopifyAPI::Page
    • class ShopifyAPI::Payment
    • class ShopifyAPI::PaymentGateway
    • class ShopifyAPI::PaymentTransaction
    • class ShopifyAPI::Payout
    • class ShopifyAPI::Policy
    • class ShopifyAPI::PriceRule
    • class ShopifyAPI::Product
    • class ShopifyAPI::ProductListing
    • class ShopifyAPI::ProductResourceFeedback
    • class ShopifyAPI::Province
    • class ShopifyAPI::RecurringApplicationCharge
    • class ShopifyAPI::Redirect
    • class ShopifyAPI::Refund
    • class ShopifyAPI::Report
    • class ShopifyAPI::ResourceFeedback
    • class ShopifyAPI::Rest::Base
    • class ShopifyAPI::Rest::BaseErrors
    • class ShopifyAPI::ScriptTag
    • class ShopifyAPI::ShippingZone
    • class ShopifyAPI::Shop
    • class ShopifyAPI::SmartCollection
    • class ShopifyAPI::StorefrontAccessToken
    • class ShopifyAPI::TenderTransaction
    • class ShopifyAPI::Theme
    • class ShopifyAPI::Transaction
    • class ShopifyAPI::UsageCharge
    • class ShopifyAPI::User
    • class ShopifyAPI::Utils::SessionUtils
    • class ShopifyAPI::Variant
    • class ShopifyAPI::Webhook
    • class ShopifyAPI::Webhooks::RegisterResult
    • class ShopifyAPI::Webhooks::Registration
    • class ShopifyAPI::Webhooks::Registrations::EventBridge
    • class ShopifyAPI::Webhooks::Registrations::Http
    • class ShopifyAPI::Webhooks::Registrations::PubSub
    • class ShopifyAPI::Webhooks::Registry
    • class ShopifyAPI::Webhooks::Request
    • class ShopifyAPI::Webhooks::WebhookMetadata
    Overview
    H
    Home
    R
    Reference
    T
    Types
    C
    Changelogs
  • Documentation
    • README
    • Readme
    • Getting started
    • Custom apps
    • Graphql
    • Graphql storefront
    • Oauth
    • Rest
    • Webhooks
  • More
    • Versions
    • Source
    • Playground
    • Stats
    • Metadata
    • Wiki
    • Announcements
    Community
    • Articles
    • Tutorials
    • Videos
    • Community
  1. Gems
  2. shopify_api

shopify_api

This gem allows Ruby developers to programmatically access the admin section of Shopify stores.

Types
Docs
Guides
Zeitwerk
Namespace
Optimized

Version

16.1.0

Authors

Shopify

Dependencies

activesupport, concurrent-ruby, hash_diff, httparty, jwt, oj, openssl, securerandom, sorbet-runtime, zeitwerk

Quick Start

bundle add shopify_api

Getting Started

Learn more about the Shopify_api gem.

Installation

Learn more about how to install and configure the gem

Documentation

Learn more about the details

Guides

Learn more about the gem in the written guides

Reference

Learn more about the classes and modules

Documentation

docs/README.md

Read about "Readme" in shopify_api

Read more

docs/getting_started.md

Read about "Getting started" in shopify_api

Read more

docs/usage/custom_apps.md

Read about "Custom apps" in shopify_api

Read more

docs/usage/graphql.md

Read about "Graphql" in shopify_api

Read more

Playground

Test, play and inspect the gem for yourself

irb(main):001:0>

            

Playground

Run a Ruby playground with the shopify_api gem pre-installed

Play

Top-Level Modules

  • ShopifyAPI
Home
Gems
Docs
Contribute
Monitoring
Twitter GitHub Mastodon

© 2026 gem.sh - Beautiful documentation for any Ruby gem