Shopify API

The ShopifyAPI library allows Python developers to programmatically access the admin section of stores.

The API is accessed using pyactiveresource in order to provide an interface similar to the ruby Shopify API gem. The data itself is sent as XML over HTTP to communicate with Shopify, which provides a web service that follows the REST principles as much as possible.

!! Breaking change notice for version 5.0.0 !!

Changes to ShopifyAPI::Session

Session creation requires a version to be set, see Api Versioning at Shopify.

To upgrade your use of ShopifyAPI you will need to make the following changes.

shopify.Session(domain, token)

is now

shopify.Session(domain, version, token)

The version argument takes a string for any known version and correctly coerce it to a shopify.ApiVersion. You can find the currently defined versions here.

For example if you want to use the 2019-04 version you would create a session like this:

session = shopify.Session(domain, '2019-04', token)

if you want to use the unstable version you would create a session like this:

session = shopify.Session(domain, 'unstable', token)

URLs that have not changed

• OAuth URLs for authorize, getting the access_token from a code, and using a refresh_token have not changed.
  • get: /admin/oauth/authorize
  • post: /admin/oauth/access_token
  • get: /admin/oauth/access_scopes
• URLs for the merchant’s web admin have not changed. For example: to send the merchant to the product page the url is still /admin/product/<id>

Usage

Requirements

All API usage happens through Shopify applications, created by either shop owners for their own shops, or by Shopify Partners for use by other shop owners:

• Shop owners can create applications for themselves through their own admin: http://docs.shopify.com/api/tutorials/creating-a-private-app
• Shopify Partners create applications through their admin: http://app.shopify.com/services/partners

For more information and detailed documentation about the API visit http://api.shopify.com

Installation

To easily install or upgrade to the latest release, use pip

pip install --upgrade ShopifyAPI

or easy_install

easy_install -U ShopifyAPI

Getting Started

ShopifyAPI uses pyactiveresource to communicate with the REST web service. pyactiveresource has to be configured with a fully authorized URL of a particular store first. To obtain that URL you can follow these steps:

1. First create a new application in either the partners admin or your store admin. You will need an API_VERSION equal to a valid version string of a Shopify API Version. For a private App you'll need the API_KEY and the PASSWORD otherwise you'll need the API_KEY and SHARED_SECRET.

2. For a private App you just need to set the base site url as follows:

   shop_url = "https://%s:%s@SHOP_NAME.myshopify.com/admin/api/%s" % (API_KEY, PASSWORD, API_VERSION)
   shopify.ShopifyResource.set_site(shop_url)

   That's it you're done, skip to step 6 and start using the API! For a partner App you will need to supply two parameters to the Session class before you instantiate it:

   shopify.Session.setup(api_key=API_KEY, secret=SHARED_SECRET)

3. In order to access a shop's data, apps need an access token from that specific shop. This is a two-stage process. Before interacting with a shop for the first time an app should redirect the user to the following URL:

   GET https://SHOP_NAME.myshopify.com/admin/oauth/authorize

   with the following parameters:

• client_id– Required – The API key for your app

• scope – Required – The list of required scopes (explained here: http://docs.shopify.com/api/tutorials/oauth)

• redirect_uri – Required – The URL where you want to redirect the users after they authorize the client. The complete URL specified here must be identical to one of the Application Redirect URLs set in the App's section of the Partners dashboard. Note: in older applications, this parameter was optional, and redirected to the Application Callback URL when no other value was specified.

• state – Optional – A randomly selected value provided by your application, which is unique for each authorization request. During the OAuth callback phase, your application must check that this value matches the one you provided during authorization. This mechanism is important for the security of your application.

  We've added the create_permision_url method to make this easier, first instantiate your session object:

  session = shopify.Session("SHOP_NAME.myshopify.com")

  Then call:

  scope=["write_products"]
  permission_url = session.create_permission_url(scope)

  or if you want a custom redirect_uri:

  permission_url = session.create_permission_url(scope, "https://my_redirect_uri.com")

4. Once authorized, the shop redirects the owner to the return URL of your application with a parameter named 'code'. This is a temporary token that the app can exchange for a permanent access token.

   Before you proceed, make sure your application performs the following security checks. If any of the checks fails, your application must reject the request with an error, and must not proceed further.

   • Ensure the provided state is the same one that your application provided to Shopify during Step 3.
   • Ensure the provided hmac is valid. The hmac is signed by Shopify as explained below, in the Verification section.
   • Ensure the provided hostname parameter is a valid hostname, ends with myshopify.com, and does not contain characters other than letters (a-z), numbers (0-9), dots, and hyphens.

   If all security checks pass, the authorization code can be exchanged once for a permanent access token. The exchange is made with a request to the shop.

   POST https://SHOP_NAME.myshopify.com/admin/oauth/access_token
   

   with the following parameters:

   * client_id – Required – The API key for your app
   * client_secret – Required – The shared secret for your app
   * code – Required – The code you received in step 3
   

   and you'll get your permanent access token back in the response.

   There is a method to make the request and get the token for you. Pass all the params received from the previous call (shop, code, timestamp, signature) as a dictionary and the method will verify the params, extract the temp code and then request your token:

   token = session.request_token(params)

   This method will save the token to the session object and return it. For future sessions simply pass the token when creating the session object.

   session = shopify.Session("SHOP_NAME.myshopify.com", token)

5. The session must be activated before use:

   shopify.ShopifyResource.activate_session(session)

6. Now you're ready to make authorized API requests to your shop! Data is returned as ActiveResource instances:

   # Get the current shop
   shop = shopify.Shop.current()
   
   # Get a specific product
   product = shopify.Product.find(179761209)
   
   # Create a new product
   new_product = shopify.Product()
   new_product.title = "Burton Custom Freestyle 151"
   new_product.product_type = "Snowboard"
   new_product.vendor = "Burton"
   success = new_product.save() #returns false if the record is invalid
   # or
   if new_product.errors:
       #something went wrong, see new_product.errors.full_messages() for example
   
   # Update a product
   product.handle = "burton-snowboard"
   product.save()
   
   # Remove a product
   product.destroy()

   Alternatively, you can use temp to initialize a Session and execute a command which also handles temporarily setting ActiveResource::Base.site:

   with shopify.Session.temp("SHOP_NAME.myshopify.com", token):
      product = shopify.Product.find()

7. If you want to work with another shop, you'll first need to clear the session::

   shopify.ShopifyResource.clear_session()

Billing

Note: Your application must be public to test the billing process. To test on a development store use the 'test': true flag

1. Create charge after session has been activated

   application_charge = shopify.ApplicationCharge.create(
     {
           'name': 'My public app',
           'price': 123,
           'test': True,
           'return_url': 'https://domain.com/approve'
       }
   )
   # Redirect user to confirmation_url so they can approve the charge

2. After approving the charge, the user is redirected to return_url with charge_id GET parameter

   charge = shopify.ApplicationCharge.find(charge_id)
   shopify.ApplicationCharge.activate(charge)

3. Check that activated_charge status is active

   activated_charge = shopify.ApplicationCharge.find(charge_id)
   has_been_billed = activated_charge.status == 'active'

Advanced Usage

It is recommended to have at least a basic grasp on the principles of ActiveResource. The pyactiveresource library, which this package relies heavily upon is a port of rails/ActiveResource to Python.

Instances of pyactiveresource resources map to RESTful resources in the Shopify API.

pyactiveresource exposes life cycle methods for creating, finding, updating, and deleting resources which are equivalent to the POST, GET, PUT, and DELETE HTTP verbs.

product = shopify.Product()
product.title = "Shopify Logo T-Shirt"
product.id                          # => 292082188312
product.save()                      # => True

shopify.Product.exists(product.id)  # => True

product = shopify.Product.find(292082188312)
# Resource holding our newly created Product object
# Inspect attributes with product.attributes

product.price = 19.99
product.save()                      # => True
product.destroy()
# Delete the resource from the remote server (i.e. Shopify)

The tests for this package also serve to provide advanced examples of usage.

Prefix options

Some resources such as Fulfillment are prefixed by a parent resource in the Shopify API.

e.g. orders/450789469/fulfillments/255858046

In order to interact with these resources, you must specify the identifier of the parent resource in your request.

e.g. shopify.Fulfillment.find(255858046, order_id=450789469)

Console

This package also includes the shopify_api.py script to make it easy to open up an interactive console to use the API with a shop.

1. Obtain a private API key and password to use with your shop (step 2 in "Getting Started")

2. Use the shopify_api.py script to save the credentials for the shop to quickly log in. The script uses PyYAML to save and load connection configurations in the same format as the ruby shopify_api.

   shopify_api.py add yourshopname

   Follow the prompts for the shop domain, API key and password.

3. Start the console for the connection.

   shopify_api.py console

4. To see the full list of commands, type:

   shopify_api.py help

GraphQL

This library also supports Shopify's new GraphQL API. The authentication process (steps 1-5 under Getting Started) is identical. Once your session is activated, simply construct a new graphql client and use execute to execute the query.

client = shopify.GraphQL()
  query = '''
    {
      shop {
        name
        id
      }
    }
  '''
  result = client.execute(query)

Using Development Version

The development version can be built using

python setup.py sdist

then the package can be installed using pip

pip install --upgrade dist/ShopifyAPI-*.tar.gz

or easy_install

easy_install -U dist/ShopifyAPI-*.tar.gz

Note Use the bin/shopify_api.py script when running from the source tree. It will add the lib directory to start of sys.path, so the installed version won't be used.

To run tests, simply open up the project directory in a terminal and run:

pip install setuptools --upgrade
python setup.py test

Alternatively, use tox to sequentially test against different versions of Python in isolated environments:

pip install tox
tox

See the tox documentation for help on running only specific environments at a time. The related tool detox can be used to run tests in these environments in parallel:

pip install detox
detox

Relative Cursor Pagination

Cursor based pagination support has been added in 6.0.0.

import shopify

page1 = shopify.Product.find()
if page1.has_next_page():
  page2 = page1.next_page()

# to persist across requests you can use next_page_url and previous_page_url
next_url = page1.next_page_url
page2 = shopify.Product.find(from_=next_url)

Limitations

Currently there is no support for:

• asynchronous requests
• persistent connections

Additional Resources

• Shopify API <= Read the tech docs!
• Ask questions on the Shopify forums <= Ask questions on the forums!

Copyright

Copyright (c) 2012 "Shopify inc.". See LICENSE for details.