Installation

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
⚠️

Your PSRESTful plan determines the number of API calls available to your account.

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 the PromoSync onboarding wizard

Onboarding Wizard

On first launch, the dashboard runs a three-step wizard that gets you from a fresh install to a working catalog. Each step gates the next, and the dashboard remembers where you left off if you close the tab.

Step 1 of 3: Connect PSRESTful

PromoSync needs a PSRESTful API key to read supplier catalogs, pricing, and inventory.

  1. Log in to your PSRESTful dashboard
  2. Open the API Keys section
  3. Click Generate New Key or copy an existing one
  4. Paste it into the PromoSync wizard and submit

If the key is rejected, double-check for stray whitespace, confirm your PSRESTful subscription is active, and confirm the key has not been revoked.

Step 2 of 3: Notification contacts

Tell PromoSync where to send async job summaries (inventory syncs, price updates, onboarding results, etc.).

  1. Enter at least one email address that should receive notifications
  2. Submit to advance

You can add or remove notification contacts later from Settings.

Step 3 of 3: Try it, import your first products

PromoSync adds two sample products from HIT Promo to your Shopify store so you can see how a finished PromoSync listing looks before importing your full catalog. The two products vary by environment but are picked to show variants, pricing tiers, and metafields populated automatically.

  1. Click Import these samples
  2. The wizard advances to an “importing” screen that polls for completion
  3. When the products land in Shopify, you’ll see a celebration screen with links to the new listings
  4. Click Continue to dashboard to exit the wizard

The demo products are real supplier records, so they include live pricing tiers, variants, and metafields. Feel free to delete them after you’ve inspected them; your dashboard will revert to the regular Overview the next time you load it.

Initial Configuration

After connecting your API key, configure these essential settings:

Pricing Strategy

Choose how pricing is calculated for imported products:

StrategyDescription
MQMinimum Quantity pricing - uses the lowest tier
HUNDREDSPrice per 100 units
MAPManufacturer’s Advertised Price
MDPApply your own markup/discount rules

See Pricing Settings for detailed configuration.

If your pricing strategy cannot be mapped to one of the options above, contact us to discuss custom pricing logic. A one-time fee applies for custom implementations.

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
⚠️

Multi-location sync is currently in Beta.

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

ProblemSolution
”Invalid API key”Verify the key was copied correctly without extra spaces
”API key expired”Generate a new key from your PSRESTful dashboard
”Rate limit exceeded”Wait a few minutes before retrying
”Unauthorized”Check your PSRESTful subscription is active

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:

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
HomeFeatures