Table of Contents - shopify_api-9.5 Documentation
Pages
- LICENSE
-
README
- Shopify API
- Usage
- Requirements
- Ruby version
- Installation
- Getting Started
- 1) Create an app
- 2A) Private Apps
- 2B) Public and Custom Apps
- 3) Requesting access from a shop
- Then, create a permission URL with the session
- 4) Trading your
code
for an access token. - 5) Activating the session
- 6A) Making requests to the GraphQL API
- Note: the GraphQL client has improved and changed in version 9.0. See the client documentation for full usage details and a migration guide.
- 6B) Making requests to the REST API
- Console
- Thread safety
- Bulk Operations
- Example
- 1) Start the bulk operation
- Step 2) Poll the status of the bulk operation
- Step 3) Retrieve your data
- Pagination
- Breaking Change Notices
- Breaking change notice for version 8.0.0
- Breaking change notice for version 7.0.0
- Changes to ShopifyAPI::Session
- Changes to how to define resources
- URL construction
- URLs that have not changed
- Using Development Version
- Logging
- Additional Resources
- Copyright
- task.rake
Classes and Modules
- ActiveResource
- ActiveResource::Connection
- ActiveResource::DetailedLogSubscriber
- ActiveResource::Errors
- ShopifyAPI
- ShopifyAPI::AbandonedCheckout
- ShopifyAPI::AccessScope
- ShopifyAPI::AccessToken
- ShopifyAPI::Address
- ShopifyAPI::Announcement
- ShopifyAPI::ApiAccess
- ShopifyAPI::ApiPermission
- ShopifyAPI::ApiVersion
- ShopifyAPI::ApiVersion::ApiVersionNotSetError
- ShopifyAPI::ApiVersion::NullVersion
- ShopifyAPI::ApiVersion::UnknownVersion
- ShopifyAPI::ApplicationCharge
- ShopifyAPI::ApplicationCredit
- ShopifyAPI::ArrayBase
- ShopifyAPI::Article
- ShopifyAPI::Asset
- ShopifyAPI::AssignedFulfillmentOrder
- ShopifyAPI::Base
- ShopifyAPI::Base::InvalidSessionError
- ShopifyAPI::BillingAddress
- ShopifyAPI::Blog
- ShopifyAPI::CarrierService
- ShopifyAPI::Cart
- ShopifyAPI::Checkout
- ShopifyAPI::Collect
- ShopifyAPI::Collection
- ShopifyAPI::CollectionListing
- ShopifyAPI::CollectionListing::ProductId
- ShopifyAPI::CollectionPublication
- ShopifyAPI::Comment
- ShopifyAPI::Connection
- ShopifyAPI::Connection::RequestNotification
- ShopifyAPI::Connection::ResponseCapture
- ShopifyAPI::Countable
- ShopifyAPI::Country
- ShopifyAPI::Currency
- ShopifyAPI::CustomCollection
- ShopifyAPI::Customer
- ShopifyAPI::CustomerGroup
- ShopifyAPI::CustomerInvite
- ShopifyAPI::CustomerSavedSearch
- ShopifyAPI::DisablePrefixCheck
- ShopifyAPI::DisablePrefixCheck::ClassMethods
- ShopifyAPI::DiscountCode
- ShopifyAPI::DiscountCodeBatch
- ShopifyAPI::DraftOrder
- ShopifyAPI::DraftOrderInvoice
- ShopifyAPI::Event
- ShopifyAPI::Events
- ShopifyAPI::Fulfillment
- ShopifyAPI::FulfillmentEvent
- ShopifyAPI::FulfillmentOrder
- ShopifyAPI::FulfillmentOrderLocationsForMove
- ShopifyAPI::FulfillmentRequest
- ShopifyAPI::FulfillmentService
- ShopifyAPI::FulfillmentV2
- ShopifyAPI::GiftCard
- ShopifyAPI::GraphQL
- ShopifyAPI::GraphQL::DEFAULT_EXECUTION_ADAPTER
- ShopifyAPI::GraphQL::HTTPClient
- ShopifyAPI::GraphQL::Railtie
- ShopifyAPI::HmacParams
- ShopifyAPI::Image
- ShopifyAPI::InvalidPaginationLinksError
- ShopifyAPI::InventoryItem
- ShopifyAPI::InventoryLevel
- ShopifyAPI::Limits
- ShopifyAPI::Limits::ClassMethods
- ShopifyAPI::Limits::LimitUnavailable
- ShopifyAPI::LineItem
- ShopifyAPI::LineItem::Property
- ShopifyAPI::Location
- ShopifyAPI::MarketingEvent
- ShopifyAPI::MessageEnricher
- ShopifyAPI::Meta
- ShopifyAPI::Metafield
- ShopifyAPI::Metafields
- ShopifyAPI::NoteAttribute
- ShopifyAPI::Option
- ShopifyAPI::Order
- ShopifyAPI::Order::ClientDetails
- ShopifyAPI::OrderRisk
- ShopifyAPI::Page
- ShopifyAPI::PaginatedCollection
- ShopifyAPI::PaginatedCollection::CollectionPagination
- ShopifyAPI::PaginationLinkHeaders
- ShopifyAPI::Payment
- ShopifyAPI::PaymentDetails
- ShopifyAPI::Policy
- ShopifyAPI::PriceRule
- ShopifyAPI::Product
- ShopifyAPI::ProductListing
- ShopifyAPI::ProductListing::ProductId
- ShopifyAPI::ProductPublication
- ShopifyAPI::Province
- ShopifyAPI::Publication
- ShopifyAPI::Receipt
- ShopifyAPI::RecurringApplicationCharge
- ShopifyAPI::Redirect
- ShopifyAPI::Refund
- ShopifyAPI::Report
- ShopifyAPI::ResourceFeedback
- ShopifyAPI::ResourceFeedback::ExistingFeedbackSaved
- ShopifyAPI::Rule
- ShopifyAPI::ScriptTag
- ShopifyAPI::Session
- ShopifyAPI::ShippingAddress
- ShopifyAPI::ShippingLine
- ShopifyAPI::ShippingRate
- ShopifyAPI::ShippingZone
- ShopifyAPI::Shop
- ShopifyAPI::SmartCollection
- ShopifyAPI::StorefrontAccessToken
- ShopifyAPI::TaxLine
- ShopifyAPI::TaxService
- ShopifyAPI::TenderTransaction
- ShopifyAPI::Theme
- ShopifyAPI::Transaction
- ShopifyAPI::UsageCharge
- ShopifyAPI::User
- ShopifyAPI::ValidationException
- ShopifyAPI::Variant
- ShopifyAPI::Webhook
- VerifyDocs
Methods
- ::activate_session — ShopifyAPI::Base
- ::add_to_known_versions — ShopifyAPI::ApiVersion
- ::admin_versions — ShopifyAPI::Meta
- ::all — ShopifyAPI::Policy
- ::api_version — ShopifyAPI::Base
- ::api_version= — ShopifyAPI::Base
- ::authors — ShopifyAPI::Article
- ::calculate — ShopifyAPI::Refund
- ::call — VerifyDocs
- ::clear_clients — ShopifyAPI::GraphQL
- ::clear_defined_versions — ShopifyAPI::ApiVersion
- ::clear_known_versions — ShopifyAPI::ApiVersion
- ::clear_session — ShopifyAPI::Base
- ::client — ShopifyAPI::GraphQL
- ::coerce_to_version — ShopifyAPI::ApiVersion
- ::construct_api_path — ShopifyAPI::ApiVersion::NullVersion
- ::construct_graphql_path — ShopifyAPI::ApiVersion::NullVersion
- ::current — ShopifyAPI::RecurringApplicationCharge
- ::current — ShopifyAPI::Shop
- ::define_known_versions — ShopifyAPI::ApiVersion
- ::delegate — ShopifyAPI::AccessToken
- ::destroy — ShopifyAPI::ApiPermission
- ::display_name — ShopifyAPI::ApiVersion::NullVersion
- ::early_july_pagination? — ShopifyAPI::Base
- ::early_july_pagination_release! — ShopifyAPI::Base
- ::element_path — ShopifyAPI::InventoryLevel
- ::encode — ShopifyAPI::HmacParams
- ::encode_key — ShopifyAPI::HmacParams
- ::encode_value — ShopifyAPI::HmacParams
- ::execution_adapter — ShopifyAPI::GraphQL
- ::execution_adapter= — ShopifyAPI::GraphQL
- ::extract_current_session — ShopifyAPI::Session
- ::fetch_known_versions — ShopifyAPI::ApiVersion
- ::find — ShopifyAPI::Asset
- ::find — ShopifyAPI::AssignedFulfillmentOrder
- ::find — ShopifyAPI::FulfillmentOrder
- ::find_version — ShopifyAPI::ApiVersion
- ::graphql_client — ShopifyAPI::GraphQL
- ::graphql_client= — ShopifyAPI::GraphQL
- ::handle — ShopifyAPI::ApiVersion::NullVersion
- ::headers — ShopifyAPI::Base
- ::headers — ShopifyAPI::Checkout
- ::included — ShopifyAPI::Limits
- ::init_prefix — ShopifyAPI::Base
- ::init_prefix_explicit — ShopifyAPI::Base
- ::initialize_client_cache — ShopifyAPI::GraphQL
- ::initialize_clients — ShopifyAPI::GraphQL
- ::instantiate_record — ShopifyAPI::ArrayBase
- ::latest_stable_version — ShopifyAPI::ApiVersion
- ::latest_supported — ShopifyAPI::ApiVersion::NullVersion
- ::latest_supported? — ShopifyAPI::ApiVersion::NullVersion
- ::matches? — ShopifyAPI::ApiVersion::NullVersion
- ::name — ShopifyAPI::ApiVersion::NullVersion
- ::new — ShopifyAPI::ApiAccess
- ::new — ShopifyAPI::ApiVersion
- ::new — ShopifyAPI::ApiVersion::NullVersion
- ::new — ShopifyAPI::GraphQL::HTTPClient
- ::new — ShopifyAPI::GraphQL::HTTPClient
- ::new — ShopifyAPI::PaginationLinkHeaders
- ::new — ShopifyAPI::AssignedFulfillmentOrder
- ::new — ShopifyAPI::FulfillmentOrder
- ::new — ShopifyAPI::FulfillmentV2
- ::new — ShopifyAPI::LineItem::Property
- ::new — ShopifyAPI::Product
- ::new — ShopifyAPI::Variant
- ::new — ShopifyAPI::Session
- ::new — ShopifyAPI::PaginatedCollection::CollectionPagination
- ::prefix — ShopifyAPI::AccessScope
- ::prefix — ShopifyAPI::Base
- ::prefix= — ShopifyAPI::Base
- ::prefix_source — ShopifyAPI::Base
- ::prepare_domain — ShopifyAPI::Session
- ::product_ids — ShopifyAPI::ProductListing
- ::raise_not_set_error — ShopifyAPI::ApiVersion::NullVersion
- ::resource_prefix — ShopifyAPI::Base
- ::resource_prefix= — ShopifyAPI::Base
- ::sanitize_known_versions — ShopifyAPI::ApiVersion
- ::schema_location — ShopifyAPI::GraphQL
- ::schema_location= — ShopifyAPI::GraphQL
- ::search — ShopifyAPI::Customer
- ::set_prefix — ShopifyAPI::Base
- ::setup — ShopifyAPI::Session
- ::stable? — ShopifyAPI::ApiVersion::NullVersion
- ::supported — ShopifyAPI::ApiVersion::NullVersion
- ::supported? — ShopifyAPI::ApiVersion::NullVersion
- ::tags — ShopifyAPI::Article
- ::temp — ShopifyAPI::Session
- ::unknown_version_error_message — ShopifyAPI::ApiVersion
- ::unstable? — ShopifyAPI::ApiVersion::NullVersion
- ::validate_signature — ShopifyAPI::Session
- ::verified — ShopifyAPI::ApiVersion::NullVersion
- ::verified? — ShopifyAPI::ApiVersion::NullVersion
- ::version_lookup_mode — ShopifyAPI::ApiVersion
- ::version_lookup_mode= — ShopifyAPI::ApiVersion
- ::version_validation! — ShopifyAPI::Base
- ::with_session — ShopifyAPI::Session
- ::with_version — ShopifyAPI::Session
- #<=> — ShopifyAPI::ApiVersion
- #== — ShopifyAPI::ApiAccess
- #== — ShopifyAPI::ApiVersion
- #== — ShopifyAPI::Session
- #accept_cancellation_request — ShopifyAPI::FulfillmentOrder
- #accept_fulfillment_request — ShopifyAPI::FulfillmentOrder
- #access_scopes= — ShopifyAPI::Session
- #access_token_request — ShopifyAPI::Session
- #account_activation_url — ShopifyAPI::Customer
- #activate — ShopifyAPI::ApplicationCharge
- #activate — ShopifyAPI::RecurringApplicationCharge
- #add_engagements — ShopifyAPI::MarketingEvent
- #add_metafield — ShopifyAPI::Shop
- #add_metafield — ShopifyAPI::Metafields
- #add_product — ShopifyAPI::CustomCollection
- #add_to_collection — ShopifyAPI::Product
- #adjust — ShopifyAPI::InventoryLevel
- #allow_inventory_params? — ShopifyAPI::Product
- #api_credit_limit_param — ShopifyAPI::Limits::ClassMethods
- #api_version= — ShopifyAPI::Session
- #approve — ShopifyAPI::Comment
- #articles — ShopifyAPI::Blog
- #as_json — ShopifyAPI::Base
- #attach — ShopifyAPI::Asset
- #attach_image — ShopifyAPI::Image
- #available_calls — ShopifyAPI::Limits::ClassMethods
- #call_count — ShopifyAPI::Limits::ClassMethods
- #call_limit — ShopifyAPI::Limits::ClassMethods
- #cancel — ShopifyAPI::Fulfillment
- #cancel — ShopifyAPI::FulfillmentOrder
- #cancel — ShopifyAPI::Order
- #cancel — ShopifyAPI::RecurringApplicationCharge
- #capture — ShopifyAPI::Order
- #check_prefix_options — ShopifyAPI::DisablePrefixCheck::ClassMethods
- #close — ShopifyAPI::FulfillmentOrder
- #close — ShopifyAPI::Order
- #collections — ShopifyAPI::Product
- #comments — ShopifyAPI::Article
- #complete — ShopifyAPI::Checkout
- #complete — ShopifyAPI::DraftOrder
- #complete — ShopifyAPI::Fulfillment
- #conditional_prefix — ShopifyAPI::DisablePrefixCheck::ClassMethods
- #connect — ShopifyAPI::InventoryLevel
- #construct_api_path — ShopifyAPI::ApiVersion
- #construct_graphql_path — ShopifyAPI::ApiVersion
- #construct_oauth_url — ShopifyAPI::Session
- #count — ShopifyAPI::Countable
- #covers? — ShopifyAPI::ApiAccess
- #create_permission_url — ShopifyAPI::Session
- #credit_left — ShopifyAPI::Limits::ClassMethods
- #credit_limit — ShopifyAPI::Limits::ClassMethods
- #credit_maxed? — ShopifyAPI::Limits::ClassMethods
- #credit_used — ShopifyAPI::Limits::ClassMethods
- #customers — ShopifyAPI::CustomerSavedSearch
- #customers — ShopifyAPI::CustomerSavedSearch
- #customize — ShopifyAPI::RecurringApplicationCharge
- #destroy — ShopifyAPI::Asset
- #destroy — ShopifyAPI::InventoryLevel
- #disable — ShopifyAPI::GiftCard
- #discount_code_job — ShopifyAPI::DiscountCodeBatch
- #discount_codes — ShopifyAPI::PriceRule
- #encode — ShopifyAPI::Base
- #encode — ShopifyAPI::DiscountCodeBatch
- #ensure_available — ShopifyAPI::PaginatedCollection::CollectionPagination
- #eql? — ShopifyAPI::ApiAccess
- #eql? — ShopifyAPI::Session
- #events — ShopifyAPI::Shop
- #events — ShopifyAPI::Events
- #expired? — ShopifyAPI::Session
- #expires_at — ShopifyAPI::Session
- #expires_in — ShopifyAPI::Session
- #extract_page_info — ShopifyAPI::PaginatedCollection::CollectionPagination
- #fetch_next_page — ShopifyAPI::PaginatedCollection::CollectionPagination
- #fetch_page — ShopifyAPI::PaginatedCollection::CollectionPagination
- #fetch_previous_page — ShopifyAPI::PaginatedCollection::CollectionPagination
- #from_hash — ActiveResource::Errors
- #from_json — ActiveResource::Errors
- #from_string — ActiveResource::Errors
- #fulfillment_id — ShopifyAPI::FulfillmentEvent
- #fulfillment_orders — ShopifyAPI::Order
- #fulfillments — ShopifyAPI::FulfillmentOrder
- #handle_as_date — ShopifyAPI::ApiVersion
- #handle_response — ShopifyAPI::Connection::ResponseCapture
- #hash — ShopifyAPI::ApiAccess
- #hash — ShopifyAPI::ApiVersion
- #hash — ShopifyAPI::Session
- #headers — ShopifyAPI::GraphQL::HTTPClient
- #headers — ShopifyAPI::GraphQL::HTTPClient
- #implied_scope — ShopifyAPI::ApiAccess
- #inventory_levels — ShopifyAPI::Location
- #inventory_quantity= — ShopifyAPI::Variant
- #inventory_quantity_adjustment= — ShopifyAPI::Variant
- #keyed_fulfillment_orders_from_response — ShopifyAPI::FulfillmentOrder
- #latest_supported? — ShopifyAPI::ApiVersion
- #load — ShopifyAPI::Fulfillment
- #load_keyed_fulfillment_order — ShopifyAPI::FulfillmentOrder
- #locations_for_move — ShopifyAPI::FulfillmentOrder
- #log_request_response_details — ActiveResource::DetailedLogSubscriber
- #logger — ActiveResource::DetailedLogSubscriber
- #mark_as_failed — ShopifyAPI::FulfillmentRequest
- #maxed? — ShopifyAPI::Limits::ClassMethods
- #message — ShopifyAPI::MessageEnricher
- #metafields — ShopifyAPI::Shop
- #metafields — ShopifyAPI::Metafields
- #move — ShopifyAPI::FulfillmentOrder
- #name — ShopifyAPI::ApiVersion
- #new? — ShopifyAPI::Asset
- #next_page? — ShopifyAPI::PaginatedCollection::CollectionPagination
- #next_page_info — ShopifyAPI::PaginatedCollection::CollectionPagination
- #not_spam — ShopifyAPI::Comment
- #notify_about_request — ShopifyAPI::Connection::RequestNotification
- #old_inventory_quantity= — ShopifyAPI::Variant
- #only_id — ShopifyAPI::Base
- #open — ShopifyAPI::Fulfillment
- #open — ShopifyAPI::FulfillmentOrder
- #open — ShopifyAPI::Order
- #order — ShopifyAPI::SmartCollection
- #order_id — ShopifyAPI::Fulfillment
- #order_id — ShopifyAPI::FulfillmentEvent
- #order_id — ShopifyAPI::FulfillmentRequest
- #order_id= — ShopifyAPI::Fulfillment
- #orders — ShopifyAPI::Customer
- #pagination_link_headers — ShopifyAPI::PaginatedCollection::CollectionPagination
- #parameterize — ShopifyAPI::Session
- #parse_link_header — ShopifyAPI::PaginationLinkHeaders
- #payments — ShopifyAPI::Checkout
- #persisted? — ShopifyAPI::Base
- #previous_page? — ShopifyAPI::PaginatedCollection::CollectionPagination
- #previous_page_info — ShopifyAPI::PaginatedCollection::CollectionPagination
- #price_range — ShopifyAPI::Product
- #price_rule_id — ShopifyAPI::DiscountCode
- #price_rule_id — ShopifyAPI::DiscountCodeBatch
- #product_ids — ShopifyAPI::CollectionListing
- #products — ShopifyAPI::Collection
- #products — ShopifyAPI::CustomCollection
- #products — ShopifyAPI::SmartCollection
- #publication_id — ShopifyAPI::CollectionPublication
- #publication_id — ShopifyAPI::ProductPublication
- #raise_deprecated_inventory_call — ShopifyAPI::Product
- #raise_deprecated_inventory_call — ShopifyAPI::Variant
- #ready? — ShopifyAPI::Checkout
- #reject_cancellation_request — ShopifyAPI::FulfillmentOrder
- #reject_fulfillment_request — ShopifyAPI::FulfillmentOrder
- #remove — ShopifyAPI::Comment
- #remove_from_collection — ShopifyAPI::Product
- #remove_product — ShopifyAPI::CustomCollection
- #request — ActiveResource::DetailedLogSubscriber
- #request — ShopifyAPI::Connection::RequestNotification
- #request_cancellation — ShopifyAPI::FulfillmentOrder
- #request_fulfillment — ShopifyAPI::FulfillmentOrder
- #request_token — ShopifyAPI::Session
- #reschedule — ShopifyAPI::FulfillmentOrder
- #response — ShopifyAPI::Limits::ClassMethods
- #restore — ShopifyAPI::Comment
- #save — ShopifyAPI::Fulfillment
- #save — ShopifyAPI::ResourceFeedback
- #save — ShopifyAPI::Variant
- #send_invite — ShopifyAPI::Customer
- #send_invoice — ShopifyAPI::DraftOrder
- #set — ShopifyAPI::InventoryLevel
- #shipping_rates — ShopifyAPI::Checkout
- #shop — ShopifyAPI::Session
- #site — ShopifyAPI::Session
- #smart_collections — ShopifyAPI::Product
- #spam — ShopifyAPI::Comment
- #stable? — ShopifyAPI::ApiVersion
- #state — ShopifyAPI::Session
- #store_scopes — ShopifyAPI::ApiAccess
- #supported? — ShopifyAPI::ApiVersion
- #to_a — ShopifyAPI::ApiAccess
- #to_s — ShopifyAPI::ApiAccess
- #to_s — ShopifyAPI::ApiVersion
- #total_inventory= — ShopifyAPI::Product
- #transactions — ShopifyAPI::Order
- #unstable? — ShopifyAPI::ApiVersion
- #update_tracking — ShopifyAPI::Fulfillment
- #update_tracking — ShopifyAPI::FulfillmentV2
- #uri — ShopifyAPI::GraphQL::HTTPClient
- #uri — ShopifyAPI::GraphQL::HTTPClient
- #usage_charges — ShopifyAPI::RecurringApplicationCharge
- #valid? — ShopifyAPI::Session
- #value — ShopifyAPI::Asset
- #value — ShopifyAPI::Metafield
- #verified? — ShopifyAPI::ApiVersion
- #warn_on_deprecated_header_or_version_eol_header — ActiveResource::DetailedLogSubscriber
- #wipe_value_attributes — ShopifyAPI::Asset