Installation

This guide walks you through installing PromoSync and connecting it to your PSRESTful API account.

Prerequisites

Before installing PromoSync, you’ll need:

1. A Shopify Store - PromoSync works with all Shopify plans
2. A PSRESTful API Account - Sign up at psrestful.com if you don’t have one
3. API Key - Generate an API key from your PSRESTful dashboard

Installing from Shopify App Store

1. Visit the PromoSync listing on the Shopify App Store
2. Click Add app to begin installation
3. Review the permissions and click Install app
4. You’ll be redirected to PromoSync’s setup wizard

Connecting Your API Key

After installation, you need to connect PromoSync to your PSRESTful API account:

Step 1: Get Your API Key

1. Log in to your PSRESTful dashboard
2. Navigate to API Keys section
3. Click Generate New Key or copy an existing key
4. Keep this key secure - it provides access to your supplier data

Step 2: Enter Your API Key

1. In PromoSync, click Settings in the navigation
2. Find the API Configuration section
3. Paste your API key into the PSRESTful API Key field
4. Click Verify to test the connection
5. Click Save once verified

// Example API response when key is verified
{
  "status": "success",
  "message": "API key verified successfully",
  "account": {
    "name": "Your Company Name",
    "plan": "Professional",
    "suppliers": 45
  }
}

Initial Configuration

After connecting your API key, configure these essential settings:

Pricing Strategy

Choose how pricing is calculated for imported products:

See Pricing Settings for detailed configuration.

Inventory Location

Select which Shopify location should receive inventory updates:

1. Go to Settings > Inventory
2. Select your primary location from the dropdown
3. Optionally enable multi-location sync for advanced setups

See Inventory Settings for more details.

Product Import Defaults

Configure default settings for product imports:

• Title Format - How product titles are generated
• SKU Strategy - How SKUs are created for variants
• Variant Grouping - How product variants are organized

See Product Import Settings for all options.

Verifying Your Setup

To verify PromoSync is properly configured:

1. Navigate to Products in PromoSync
2. Click Import Products
3. Search for any product (e.g., “t-shirt”)
4. Preview a product to verify:
   • Images load correctly
   • Pricing displays properly
   • Inventory shows available

If you see product data, your setup is complete.

Troubleshooting

API Key Issues

Connection Issues

If PromoSync cannot connect to the PSRESTful API:

1. Check your internet connection
2. Verify the API key is valid in your PSRESTful dashboard
3. Ensure your PSRESTful subscription is active
4. Try refreshing the page and reconnecting

Getting Help

If you continue to experience issues:

• Check the PSRESTful status page for service issues
• Contact support through the Shopify App Store listing
• Review the PSRESTful API documentation

Next Steps

Once installation is complete:

1. Configure your settings - Set up pricing, inventory, and import preferences
2. Import your first products - Learn how to find and import products
3. Explore features - Discover all PromoSync capabilities