Prerequisites
- A Shopify store (or partner account)
- Admin access to your Shopify store
Getting Your API Credentials
For Shopify Partners
- Visit the Shopify Partners Dashboard
- Sign in to your partner account
- Go to “Apps” > “Create app”
- Choose “Custom app” or “Public app”
- Fill in the app details and create the app
For Store Owners
- Sign in to your Shopify Admin
- Go to “Settings” > “Apps and sales channels”
- Click “Develop apps” or “Manage private apps”
- Click “Create an app”
- Give your app a name and description
Configuring Your Shopify App
API Credentials
- In your app settings, go to “API credentials”
- Note your API key and API secret key (you’ll need these later)
- Configure the required scopes for your app
Required Scopes
Add the following scopes based on your needs:Read Access
read_products
- Access product informationread_orders
- Access order informationread_customers
- Access customer informationread_inventory
- Access inventory levelsread_analytics
- Access analytics data
Write Access
write_products
- Create and update productswrite_orders
- Update order statuswrite_customers
- Create and update customerswrite_inventory
- Update inventory levelswrite_fulfillments
- Manage order fulfillments
Additional Scopes
read_themes
- Access theme informationwrite_themes
- Modify themesread_script_tags
- Access script tagswrite_script_tags
- Manage script tags
Setting Up in Jinba Flow
- Go to your workspace settings in Jinba Flow
- Navigate to the “Secret” section
- Find “Shopify” in the list of available credentials
- Click “Configure” or “Add New”
- Enter your Shopify API credentials:
- API Key: From your Shopify app’s API credentials
- API Secret Key: From your Shopify app’s API credentials
- Store URL: Your Shopify store URL (e.g.,
your-store.myshopify.com
) - Access Token: Your app’s access token (if using OAuth)
- Click “Save” to store your credentials
Installing Your App
For Custom Apps
- In your app settings, go to “App setup”
- Copy the installation URL
- Open the URL in a browser
- Select your store and install the app
- Note the access token provided
For Public Apps
- Submit your app for review (if required)
- Users can install your app from the Shopify App Store
- Handle the OAuth flow for each installation
Usage
Once configured, you can use Shopify in your flows to:- Create and update product listings
- Manage inventory levels
- Process and update orders
- Handle customer information
- Generate sales reports
- Manage shipping and fulfillment
- Update store settings
API Endpoints
Products
- Create and update products
- Manage product variants
- Handle product images
- Update inventory levels
- Manage product collections
Orders
- Retrieve order information
- Update order status
- Process order fulfillment
- Handle order cancellations
- Manage shipping information
Customers
- Create and update customer accounts
- Access customer information
- Handle customer orders
- Manage customer addresses
Analytics
- Generate sales reports
- Access performance metrics
- Track inventory movements
- Analyze customer behavior