Shopify
Get started with the Shopify source!
Connector Details
Name | Value |
---|---|
Platform | Shopify |
Auth Type | API Key, OAuth |
Sync Type | Incremental |
Direction | Bidirectional |
API version | REST API, Docs |
Testing Account | Free Shopify Partner Account |
Unified Schema | Supported in the E-Commerce Schema |
Connector Versions
Name | Version | Stage | Description |
---|---|---|---|
Shopify | v1 | GA | Supports production Shopify online accounts |
Authorization
There are two ways to use Shopify: either via a Shopify Public App (OAuth) or using a Private App (API keys). We have guides for both of these options below:
Private App
These steps will be performed by each of your customers when they connect their Shopify account.
The first thing you need to do is log in to Shopify. If you're just testing you can create a free partner account.
Once logged in on the left side of the screen, you should select the Apps option in the navigation bar.
You should now be on the Apps page of your store. Near the bottom, you should click the link that says Manage private apps.
If you have not enabled private apps yet, your page will look like this. Click the Enable private app development button to get started.
It will ask you a few things. You should check all these off and hit the Enable private app development button.
This will now take you back to the Apps page, but now will give you the option to create a private app. You should select the Create Private App button.
Next, you need to fill in the private app name and your email.
Now you want to click the Show inactive Admin API permissions drop down in order to configure what data you would like to be able to pull from Shopify.
This will drop down a bunch of permissions that you can change. Configure the permissions as needed, and then click the Save button in the top right corner.
If you plan to use both the Shopify source and target make sure to enable Read and write access. Otherwise, Read access is sufficient.
Once you have clicked Save, this popup will appear. Click the Create app button.
From here you can get the API Password field which is required for the Shopify source to work properly.
If you plan to use triggers with the Shopify source, make sure to keep your API key as well.
Now you can insert the API Password into your hotglue Shopify source settings along with the name of your Shop:
That's it!
Supported Data
The Shopify tap currently supports the following objects:
Name | Description |
---|---|
abandoned_checkouts | A checkout is considered abandoned after the customer has added contact information, but before the customer has completed their purchase. |
collects | Collects are meant for managing the relationship between products and custom collections. For every product in a custom collection there is a collect that tracks the ID of both the product and the custom collection |
custom_collections | A custom collection is a grouping of products that a merchant can create to make their store easier to browse. The merchant creates a custom collection and then selects the products that will go into it. |
customers | Retrieves the customers for a shop and returns the associated ID. |
discount_codes | Each discount code belongs to a price rule, which holds the logic for the discount. For more information, see the PriceRule resource. |
events_products | |
incoming_items | |
inventory_items | Represents the items in the inventory. |
inventory_levels | An inventory level represents the quantities of an inventory item for a location. |
locations | Represnts the location of the available stores. |
metafields | Each metafield definition has a type, which defines the type of information that it can store. This type is enforced across every instance of the resource that owns the metafield definition. |
order_refunds | |
orders | Returns an Order resource by ID. |
price_rules | Returns a price rule resource by ID. |
products | List of products available in the store is kept here. |
shop | |
smart_collections | A smart collection is a grouping of products defined by rules that are set by the merchant. |
transactions | Balance Transactions make up the canonical "statement of account", or ledger for a Shopify Payments account. |
Don't see something you're looking for? Let us know
You can always edit the data you're pulling from the Shopify connector in the field map settings:
Updated 5 months ago