Skip to Content
shopify.dev docs
  • Apps
  • Themes
  • Custom storefronts
  • Marketplaces
    • Apps

      • GraphQL Admin API
      • REST Admin API
    • Themes

      • Liquid
      • Ajax API
    • Custom storefronts

      • Storefront API
      • Hydrogen
      • View all
  • Log in
  • Sign up
shopify.dev docs
  • Apps
  • Themes
  • Custom storefronts
  • Marketplaces
  • APIs and references
      • GraphQL Admin API
      • REST Admin API
      • Liquid
      • Ajax API
      • Storefront API
      • Hydrogen
      • View all
  • Apps
    • Overview
    • Create an app
      • Overview
      • Frontend
      • Backend
      • Connect frontend and backend
    • Existing apps
    • Overview
    • Overview
      • Overview
      • Commands
      • App structure
      • CI/CD
      • Migrate to 3.x
        • Overview
        • Uninstall
        • Install or upgrade
        • CI/CD
      • Overview
        • App setup
        • Using React
        • Overview
        • App state
        • Button
        • ButtonGroup
        • Cart
        • ContextualSaveBar
        • Error
        • Features
        • Fullscreen
        • Loading
          • Overview
          • Channel Menu
          • Navigation Menu
        • Modal
          • Overview
          • History
          • Redirect / Navigate
        • POS
        • unstable_Picker
        • ResourcePicker
        • Scanner
        • Sharing
        • TitleBar
        • Toast
      • Methods
        • Overview
        • Updating from Legacy SDKs
        • Updating to 2.0
        • Updating to 3.0
      • Mobile optimization
      • Debugging
    • Polaris
      • Overview
      • Test data
    • API libraries
    • GraphiQL Admin API explorer
    • Overview
      • Overview
      • General
      • Admin
      • Storefront
      • Checkout
    • Accessibility
      • Overview
      • Getting started
    • Embedding
    • Mobile
    • Deceptive code
    • Overview
      • Overview
      • Anatomy
      • App body
      • Full-screen mode
      • Overview
      • Responsive layout grid
      • App Body width
      • Options
      • Spacing
      • Information density
      • Containers
      • Overview
      • Branding
      • Color
      • App icon
      • Typography
      • Icons
      • Illustrations
      • Overview
      • Voice and tone
      • Product content
      • Grammar and mechanics
      • Overview
      • Information architecture
      • App nav
      • App header
      • Page header
      • Alerts
      • App home page
      • Onboarding
    • Overview
    • Build options
      • Overview
        • Overview
        • Getting started
        • UX guidelines
        • Overview
        • Getting started
        • Create a subscription
          • Overview
          • Upsell
          • Subscriptions
      • Overview
        • Overview
        • Getting started
        • Overview
        • Getting started
        • UX guidelines
      • Overview
      • Getting started
      • Add configuration
      • Build a user interface
      • UX guidelines
      • Overview
      • Getting started
      • Add configuration
      • Build a user interface
      • UX guidelines
      • Overview
      • Getting started
      • UX guidelines
      • Overview
      • Validate fields
      • Validate carts and checkouts
    • Advanced checkout branding
      • Overview
        • Overview
        • Getting started
      • Testing UI extensions
      • UX guidelines
    • Overview
      • Overview
      • Getting started
      • Framework
      • UX guidelines
      • Update your app
      • ScriptTag resource
      • App proxies
      • Asset resource
    • Verify theme support
      • Media for products
      • Media for product variants
    • Overview
    • Build options
      • Overview
      • Getting started
        • Overview
        • Getting started
        • Add configuration
        • Build a user interface
        • UX guidelines
      • Overview
      • Getting started
      • Add a custom bundle
      • Build a user interface
      • Create a bundle app
      • Overview
        • Overview
        • Modeling apps
          • Overview
          • Manage selling plans
          • Overview
          • Create a subscription contract
          • Update a subscription contract
          • Overview
          • Manage billing cycle contracts
          • Link billing cycle contracts
        • Orders
          • Overview
          • Manage fulfillments
          • Overview
          • Migrate customer information
          • Migrate existing subscription
          • UX guidelines
        • Overview
        • Modeling apps
        • Manage deferred purchase options
          • Overview
          • Manage delivery profiles
          • Getting started
          • Add app components
        • Overview
        • Getting started
        • Extension points
        • Authenticate app extension requests
        • Create and manage app extensions
        • Overview
        • Create customer-facing portals
    • Overview
    • Triggers
    • Actions
    • Webhooks
    • Overview
    • Getting started
    • Create a payments app
    • Manage encryption certificates
      • Overview
        • Overview
        • Offsite
        • Credit Card
      • Process a refund
      • Capture an authorized payment
      • Void an authorized payment
    • Test a payments app
    • Onboard a merchant to a payments app
    • Overview
      • Overview
      • Quantities and states
      • Overview
      • Test orders
      • Edit existing orders
      • Manage fulfillments
      • Track marketplace orders
      • Build location rules
      • Build fulfillment constraints
      • Overview
      • Manage fulfillments
      • Overview
      • Manage returns
      • Preview and refund duties
      • Manage reverse fulfillment orders
      • Manage reverse deliveries
    • Migrate to fulfillment orders
    • Overview
      • Overview
      • Getting started
      • Migrate to catalogs
    • Translate content
    • Locally required order data
    • Overview
    • Getting started
    • Company locations
    • Catalogs
    • Draft orders
    • Import B2B orders
    • Overview
    • Getting started
    • Point of Sale links
    • Cart app extension
    • Product recommendations extension
    • Overview
    • Getting started
      • Overview
      • Create cart permalinks
      • Overview
      • Integrate with scheduled publishing
    • Getting paid
    • Overview
      • Overview
      • Getting started
      • Overview
      • Manage customer segments
      • Migrate saved searches
      • Migrate to async queries
      • Overview
      • Getting started
      • Manage marketing activities
      • Connect a marketing app
      • Overview
      • Create an action
      • Action endpoints
    • SEO
    • Overview
      • Overview
      • Check NFT sales eligibility
      • Merchant eligibility
      • Overview
        • Overview
        • Create gates
        • Show gates
        • Apply discount
      • UX guidelines
    • Overview
      • Overview
      • Getting started
        • Overview
        • Getting started
      • Access modes
      • Rotate or revoke client credentials
        • Overview
        • Create a token
        • Overview
        • Node and PHP
        • Ruby
      • Uninstall an app
    • Access tokens for admin custom apps
    • Overview
    • Best practices
      • Overview
      • HTTPS
      • Amazon EventBridge
      • Google Cloud Pub/Sub
      • Mandatory webhooks
    • API versions
    • Troubleshooting
    • Overview
    • Getting started
    • List of app extensions
    • Overview
    • Ownership
      • Overview
      • Types
      • Manage metafields
        • Overview
        • Access control
        • Standard metafield definitions
        • Manage metafield definitions
        • Create an automated collection with metafields
          • Overview
          • Manage validation options
      • App-data metafields
      • Private metafields
      • Migrate metafields
      • Overview
      • Manage metaobjects
      • Access controls
      • Capabilities
    • Overview
      • Overview
      • Input queries and metafields
      • Variables in input queries
      • Overview
      • JavaScript
      • Rust
      • WebAssembly
    • Development practices
    • Overview
    • Deploy a web app
    • Deploy an extension
    • Overview
    • Select a distribution method
    • Overview
    • Supported billing models
    • Create one-time app purchases
      • Overview
      • Create recurring charges based on time
      • Create recurring charges based on usage
      • Update the maximum amount of a charge
      • Cancel recurring charges
      • Create annually recurring charges
      • Award app credits
      • Create recurring charge discounts
      • Refund app charges
      • Offer free trials of your app
    • Report data on app charges and earnings
    • Overview
    • Requirements
      • Overview
      • Testing your app
      • Submitting your app
      • App performance checks
      • App categories
      • Prohibited app actions
      • Common app rejections
      • App audit process
      • Overview
      • Achievement criteria
      • Overview
        • Overview
          • Overview
          • Writing a press release
          • Brand asset guidance
          • Overview
          • Tracking your listing traffic
      • Managing app reviews
        • Overview
        • Sunsetting your app
      • Tracking app usage
    • App listing visibility
    • App revenue share
      • Protected customer data
      • GDPR
      • Overview
      • Getting started
      • Creating ads
      • Managing ads
      • Ad reporting
      • Ad billing
      • Ad permissions
      • Frequently asked questions
      • Common vulnerabilities
      • TLS certificates
      • iFrame protection
      • Network services
      • GDPR Webhooks
      • Secure tokens
      • Shortened URLs
  • Log in
  • Sign up
Opens in a new windowOpens an external siteOpens an external site in a new window
  • Apps
    • Overview
    • Create an app
      • Overview
      • Frontend
      • Backend
      • Connect frontend and backend
    • Existing apps
    • Overview
    • Overview
      • Overview
      • Commands
      • App structure
      • CI/CD
      • Migrate to 3.x
        • Overview
        • Uninstall
        • Install or upgrade
        • CI/CD
      • Overview
        • App setup
        • Using React
        • Overview
        • App state
        • Button
        • ButtonGroup
        • Cart
        • ContextualSaveBar
        • Error
        • Features
        • Fullscreen
        • Loading
          • Overview
          • Channel Menu
          • Navigation Menu
        • Modal
          • Overview
          • History
          • Redirect / Navigate
        • POS
        • unstable_Picker
        • ResourcePicker
        • Scanner
        • Sharing
        • TitleBar
        • Toast
      • Methods
        • Overview
        • Updating from Legacy SDKs
        • Updating to 2.0
        • Updating to 3.0
      • Mobile optimization
      • Debugging
    • Polaris
      • Overview
      • Test data
    • API libraries
    • GraphiQL Admin API explorer
    • Overview
      • Overview
      • General
      • Admin
      • Storefront
      • Checkout
    • Accessibility
      • Overview
      • Getting started
    • Embedding
    • Mobile
    • Deceptive code
    • Overview
      • Overview
      • Anatomy
      • App body
      • Full-screen mode
      • Overview
      • Responsive layout grid
      • App Body width
      • Options
      • Spacing
      • Information density
      • Containers
      • Overview
      • Branding
      • Color
      • App icon
      • Typography
      • Icons
      • Illustrations
      • Overview
      • Voice and tone
      • Product content
      • Grammar and mechanics
      • Overview
      • Information architecture
      • App nav
      • App header
      • Page header
      • Alerts
      • App home page
      • Onboarding
    • Overview
    • Build options
      • Overview
        • Overview
        • Getting started
        • UX guidelines
        • Overview
        • Getting started
        • Create a subscription
          • Overview
          • Upsell
          • Subscriptions
      • Overview
        • Overview
        • Getting started
        • Overview
        • Getting started
        • UX guidelines
      • Overview
      • Getting started
      • Add configuration
      • Build a user interface
      • UX guidelines
      • Overview
      • Getting started
      • Add configuration
      • Build a user interface
      • UX guidelines
      • Overview
      • Getting started
      • UX guidelines
      • Overview
      • Validate fields
      • Validate carts and checkouts
    • Advanced checkout branding
      • Overview
        • Overview
        • Getting started
      • Testing UI extensions
      • UX guidelines
    • Overview
      • Overview
      • Getting started
      • Framework
      • UX guidelines
      • Update your app
      • ScriptTag resource
      • App proxies
      • Asset resource
    • Verify theme support
      • Media for products
      • Media for product variants
    • Overview
    • Build options
      • Overview
      • Getting started
        • Overview
        • Getting started
        • Add configuration
        • Build a user interface
        • UX guidelines
      • Overview
      • Getting started
      • Add a custom bundle
      • Build a user interface
      • Create a bundle app
      • Overview
        • Overview
        • Modeling apps
          • Overview
          • Manage selling plans
          • Overview
          • Create a subscription contract
          • Update a subscription contract
          • Overview
          • Manage billing cycle contracts
          • Link billing cycle contracts
        • Orders
          • Overview
          • Manage fulfillments
          • Overview
          • Migrate customer information
          • Migrate existing subscription
          • UX guidelines
        • Overview
        • Modeling apps
        • Manage deferred purchase options
          • Overview
          • Manage delivery profiles
          • Getting started
          • Add app components
        • Overview
        • Getting started
        • Extension points
        • Authenticate app extension requests
        • Create and manage app extensions
        • Overview
        • Create customer-facing portals
    • Overview
    • Triggers
    • Actions
    • Webhooks
    • Overview
    • Getting started
    • Create a payments app
    • Manage encryption certificates
      • Overview
        • Overview
        • Offsite
        • Credit Card
      • Process a refund
      • Capture an authorized payment
      • Void an authorized payment
    • Test a payments app
    • Onboard a merchant to a payments app
    • Overview
      • Overview
      • Quantities and states
      • Overview
      • Test orders
      • Edit existing orders
      • Manage fulfillments
      • Track marketplace orders
      • Build location rules
      • Build fulfillment constraints
      • Overview
      • Manage fulfillments
      • Overview
      • Manage returns
      • Preview and refund duties
      • Manage reverse fulfillment orders
      • Manage reverse deliveries
    • Migrate to fulfillment orders
    • Overview
      • Overview
      • Getting started
      • Migrate to catalogs
    • Translate content
    • Locally required order data
    • Overview
    • Getting started
    • Company locations
    • Catalogs
    • Draft orders
    • Import B2B orders
    • Overview
    • Getting started
    • Point of Sale links
    • Cart app extension
    • Product recommendations extension
    • Overview
    • Getting started
      • Overview
      • Create cart permalinks
      • Overview
      • Integrate with scheduled publishing
    • Getting paid
    • Overview
      • Overview
      • Getting started
      • Overview
      • Manage customer segments
      • Migrate saved searches
      • Migrate to async queries
      • Overview
      • Getting started
      • Manage marketing activities
      • Connect a marketing app
      • Overview
      • Create an action
      • Action endpoints
    • SEO
    • Overview
      • Overview
      • Check NFT sales eligibility
      • Merchant eligibility
      • Overview
        • Overview
        • Create gates
        • Show gates
        • Apply discount
      • UX guidelines
    • Overview
      • Overview
      • Getting started
        • Overview
        • Getting started
      • Access modes
      • Rotate or revoke client credentials
        • Overview
        • Create a token
        • Overview
        • Node and PHP
        • Ruby
      • Uninstall an app
    • Access tokens for admin custom apps
    • Overview
    • Best practices
      • Overview
      • HTTPS
      • Amazon EventBridge
      • Google Cloud Pub/Sub
      • Mandatory webhooks
    • API versions
    • Troubleshooting
    • Overview
    • Getting started
    • List of app extensions
    • Overview
    • Ownership
      • Overview
      • Types
      • Manage metafields
        • Overview
        • Access control
        • Standard metafield definitions
        • Manage metafield definitions
        • Create an automated collection with metafields
          • Overview
          • Manage validation options
      • App-data metafields
      • Private metafields
      • Migrate metafields
      • Overview
      • Manage metaobjects
      • Access controls
      • Capabilities
    • Overview
      • Overview
      • Input queries and metafields
      • Variables in input queries
      • Overview
      • JavaScript
      • Rust
      • WebAssembly
    • Development practices
    • Overview
    • Deploy a web app
    • Deploy an extension
    • Overview
    • Select a distribution method
    • Overview
    • Supported billing models
    • Create one-time app purchases
      • Overview
      • Create recurring charges based on time
      • Create recurring charges based on usage
      • Update the maximum amount of a charge
      • Cancel recurring charges
      • Create annually recurring charges
      • Award app credits
      • Create recurring charge discounts
      • Refund app charges
      • Offer free trials of your app
    • Report data on app charges and earnings
    • Overview
    • Requirements
      • Overview
      • Testing your app
      • Submitting your app
      • App performance checks
      • App categories
      • Prohibited app actions
      • Common app rejections
      • App audit process
      • Overview
      • Achievement criteria
      • Overview
        • Overview
          • Overview
          • Writing a press release
          • Brand asset guidance
          • Overview
          • Tracking your listing traffic
      • Managing app reviews
        • Overview
        • Sunsetting your app
      • Tracking app usage
    • App listing visibility
    • App revenue share
      • Protected customer data
      • GDPR
      • Overview
      • Getting started
      • Creating ads
      • Managing ads
      • Ad reporting
      • Ad billing
      • Ad permissions
      • Frequently asked questions
      • Common vulnerabilities
      • TLS certificates
      • iFrame protection
      • Network services
      • GDPR Webhooks
      • Secure tokens
      • Shortened URLs
  • Official Shopify Admin API libraries
  • Third-party Admin API libraries

API libraries

Shopify provides several official libraries for interacting with the Admin API. Members of the Shopify developer community have created similar libraries covering other languages and technology stacks.

Official Shopify Admin API libraries

Anchor link to section titled "Official Shopify Admin API libraries"

Shopify/shopify-api-ruby

Shopify’s official Ruby gem for interacting with the Admin API

Shopify/shopify-api-js

Shopify’s official Node library for interacting with the Admin API

Shopify/shopify-api-php

Shopify’s official PHP library for interacting with the Admin API

Third-party Admin API libraries

Anchor link to section titled "Third-party Admin API libraries"

Tip

These libraries are created and maintained by members of the Shopify community. They aren’t official Shopify API libraries.

Node

Anchor link to section titled "Node"

Shopify-api-node

Node Shopify connector

shopify-node-api

OAuth2 Module for Shopify API

PHP

Anchor link to section titled "PHP"

php-shopify

PHP SDK for Shopify API

shopify-php-sdk

PHP SDK for development with the Shopify API

Basic-Shopify-API

A simple, tested, API wrapper for Shopify using Guzzle for REST and GraphQL

.NET

Anchor link to section titled ".NET"

ShopifySharp

A .NET core library that helps developers easily authenticate with and manage Shopify stores.

On this page

  • Official Shopify Admin API libraries
  • Third-party Admin API libraries

Updates & News

  • Developer changelog
  • Partner blog
  • Engineering blog
  • UX blog

Community

  • Developer forum
  • Discord
  • Twitter
  • YouTube

Events

  • Unite
  • Meetups

Legal

  • Terms of Service
  • API Terms of Service
  • Privacy policy

Subscribe to receive updates from Shopify

Subscribe to receive updates from Shopify

Thanks! We’ll be in touch.

  • About Shopify
  • Shopify Plus
  • Careers
  • Investors
  • Press and Media