ShopSync Documentation

Complete guide to managing your multi-platform e-commerce stores with ShopSync.

Getting Started

Welcome to ShopSync!

This guide will walk you through everything you need to know to get started with ShopSync, from creating your account to managing multiple e-commerce stores efficiently.

Creating Your Account

ShopSync offers multiple ways to create an account. Choose the method that works best for you:

Google Account

  1. 1.Click "Continue with Google" on the login page
  2. 2.Select your Google account
  3. 3.Grant permissions when prompted
  4. 4.You'll be automatically signed in

Facebook Account

  1. 1.Click "Continue with Facebook"
  2. 2.Log in to Facebook if needed
  3. 3.Authorize ShopSync access
  4. 4.Your profile will be created automatically

Email & Password

  1. 1.Click "Sign up" or "Get Started"
  2. 2.Enter your full name and email
  3. 3.Choose a strong password (6+ characters)
  4. 4.Click "Create Account" to finish

Account Security

For email/password accounts, make sure to use a unique, strong password. We recommend using a password manager to generate and store secure passwords.

WooCommerce Integration

Fully Operational

WooCommerce integration is fully tested and ready to use with complete sync capabilities.

Step 1: Generate WooCommerce API Keys

Before connecting your WooCommerce store to ShopSync, you need to generate API credentials from your WordPress admin panel:

  1. 1
    Log in to WordPress Admin

    Navigate to your WordPress admin dashboard (usually at yourstore.com/wp-admin)

  2. 2
    Navigate to WooCommerce Settings

    Go to WooCommerce → Settings → Advanced → REST API

  3. 3
    Add API Key

    Click "Add key" button to create new API credentials

  4. 4
    Configure Permissions
    • Description: "ShopSync Integration"
    • User: Select your admin user
    • Permissions: Select "Read/Write"
  5. 5
    Save API Keys

    After generating, copy both the Consumer Key and Consumer Secret - you won't be able to see the secret again!

Security Warning

Keep your API keys secure! Never share them publicly or commit them to version control. ShopSync encrypts your credentials in our database for maximum security.

Step 2: Connect Store in ShopSync

  1. 1
    Go to Shops Page

    In your ShopSync dashboard, navigate to Shops in the sidebar

  2. 2
    Add New Shop

    Click the "Add Shop" or "Connect Store" button

  3. 3
    Fill in Shop Details
    • Shop Name: A friendly name for your store (e.g., "My Main Store")
    • Platform: Select "WooCommerce"
    • Shop URL: Your store URL (e.g., https://yourstore.com)
    • Consumer Key: Paste the key from Step 1
    • Consumer Secret: Paste the secret from Step 1
  4. 4
    Test & Save

    Click "Test Connection" to verify your credentials, then save when successful

Common Connection Issues

Error: "Invalid URL"

Solution: Make sure your URL includes https:// or http:// and does not end with a trailing slash. Example: https://yourstore.com

Error: "Authentication Failed"

Solution: Double-check your Consumer Key and Consumer Secret. Make sure you copied them completely without extra spaces.

Error: "Permission Denied"

Solution: Make sure you selected "Read/Write" permissions when generating the API keys, not just "Read".

Platform Integrations Overview

ShopSync supports multiple e-commerce platforms out of the box. Each integration is fully tested and ready for production use.

WooCommerce

Full integration with WordPress WooCommerce stores using REST API v3 with OAuth 1.0a authentication.

Fully Operational

Shopify

Complete integration with Shopify stores using Admin API with custom app access tokens.

Fully Operational

PrestaShop

Full support for PrestaShop stores using Web Services API with secure API key authentication.

Fully Operational

Magento

Comprehensive integration with Magento 2 stores using REST API with admin access tokens.

Fully Operational

Getting Started

Click on any platform below to see detailed setup instructions for generating API credentials and connecting your store to ShopSync.

Shopify Integration

Fully Operational

Shopify integration is fully tested and ready to use with complete sync capabilities.

Step 1: Create a Custom App in Shopify

  1. 1
    Log in to Shopify Admin

    Go to your Shopify admin dashboard at your-store.myshopify.com/admin

  2. 2
    Navigate to Apps and Sales Channels

    Go to Settings → Apps and sales channels

  3. 3
    Develop Apps

    Click "Develop apps" button, then "Create an app"

  4. 4
    Configure API Scopes

    Configure Admin API scopes. Required scopes:

    • • read_products, write_products
    • • read_orders, write_orders
    • • read_inventory, write_inventory
  5. 5
    Install App and Get Access Token

    Click "Install app" and copy the Admin API access token - you won't see it again!

Step 2: Connect Store in ShopSync

  1. 1
    Add New Shop

    In ShopSync dashboard, go to Shops and click "Add Shop"

  2. 2
    Fill in Shop Details
    • Shop Name: A friendly name (e.g., "My Shopify Store")
    • Platform: Select "Shopify"
    • Shop URL: Your store URL (e.g., https://your-store.myshopify.com)
    • Shop Domain: your-store.myshopify.com
    • Access Token: The token from Step 1
  3. 3
    Test & Save

    Click "Test Connection" to verify, then save when successful

PrestaShop Integration

Fully Operational

PrestaShop integration is fully tested and ready to use with complete sync capabilities.

Step 1: Enable Web Services and Generate API Key

  1. 1
    Log in to PrestaShop Back Office

    Access your PrestaShop admin panel

  2. 2
    Enable Web Services

    Go to Advanced Parameters → Web service, then enable "Enable PrestaShop's web service"

  3. 3
    Add New Web Service Key

    Click "Add new web service key"

  4. 4
    Configure Permissions

    Set permissions for:

    • • Products: View (GET), Add (POST), Edit (PUT), Delete (DELETE)
    • • Orders: View (GET), Add (POST), Edit (PUT)
    • • Stock Available: View (GET), Edit (PUT)
  5. 5
    Generate and Save Key

    Click "Generate" to create the API key, then save it securely

Step 2: Connect Store in ShopSync

  1. 1
    Add New Shop

    In ShopSync dashboard, go to Shops and click "Add Shop"

  2. 2
    Fill in Shop Details
    • Shop Name: A friendly name (e.g., "My PrestaShop Store")
    • Platform: Select "PrestaShop"
    • Shop URL: Your store URL (e.g., https://yourstore.com)
    • API Key: The Web Service key from Step 1
  3. 3
    Test & Save

    Click "Test Connection" to verify, then save when successful

Magento Integration

Fully Operational

Magento 2 integration is fully tested and ready to use with complete sync capabilities.

Step 1: Create Integration and Generate Access Token

  1. 1
    Log in to Magento Admin

    Access your Magento 2 admin panel

  2. 2
    Navigate to Integrations

    Go to System → Extensions → Integrations

  3. 3
    Add New Integration

    Click "Add New Integration"

    • Name: "ShopSync Integration"
    • Your Password: Enter your admin password
  4. 4
    Set API Permissions

    In "API" tab, select resources:

    • • Catalog (Products, Categories)
    • • Sales (Orders, Invoices, Shipments)
    • • Inventory
  5. 5
    Activate and Get Token

    Save the integration, then click "Activate". Copy the Access Token securely

Step 2: Connect Store in ShopSync

  1. 1
    Add New Shop

    In ShopSync dashboard, go to Shops and click "Add Shop"

  2. 2
    Fill in Shop Details
    • Shop Name: A friendly name (e.g., "My Magento Store")
    • Platform: Select "Magento"
    • Shop URL: Your store URL (e.g., https://yourstore.com)
    • Access Token: The token from Step 1
  3. 3
    Test & Save

    Click "Test Connection" to verify, then save when successful

Product Management

Adding Products Manually

To add a product manually without barcode scanning:

  1. Navigate to Products in the sidebar
  2. Click "Add Product" button
  3. Fill in the product details:
    • Product Name: The name of your product
    • SKU: Stock Keeping Unit (unique identifier)
    • EAN Code: Barcode number (optional)
    • Description: Detailed product description
    • Price: Product price in your currency
    • Stock Quantity: Current inventory level
    • Category: Product category for organization
  4. Upload product images (multiple images supported)
  5. Click "Save Product" to add to your catalog

Using the Barcode Scanner

Quick Product Entry

The barcode scanner automatically looks up product information from public databases, saving you time on manual data entry.

Granting Camera Permissions

Desktop (Chrome/Edge/Firefox)
  1. 1. Click the camera icon in the address bar
  2. 2. Select "Allow" for camera access
  3. 3. Refresh the page if needed
Mobile (iOS/Android)
  1. 1. Browser will prompt for camera permission
  2. 2. Tap "Allow" or "OK"
  3. 3. If denied, go to browser settings to enable

Scanning Process

  1. 1
    Open Scanner

    Navigate to Scan in the dashboard sidebar

  2. 2
    Position Barcode

    Hold the product barcode in front of your camera. The scanner supports EAN-8, EAN-13, and UPC codes

  3. 3
    Automatic Detection

    The scanner will automatically detect and read the barcode

  4. 4
    Product Lookup

    ShopSync searches OpenFoodFacts and UPCItemDB for product information

  5. 5
    Review & Edit

    Review the fetched data, make any necessary edits, then save the product

Product Data Sources

ShopSync uses multiple public databases:

  • OpenFoodFacts: Excellent for food products
  • UPCItemDB: General merchandise and consumer goods
  • Local Cache: Previously scanned products for instant lookup

Product Synchronization

When you add or update products in ShopSync, changes can be synchronized to your connected stores:

  • Automatic sync happens every 15 minutes for active stores
  • Manual sync available with "Sync Now" button
  • Sync status indicators show which products are synced
  • Conflict resolution prioritizes most recent changes

Order Management

ShopSync automatically fetches orders from all your connected stores and displays them in a unified dashboard.

Order Status Workflow

Pending

Order received, awaiting payment confirmation

Processing

Payment confirmed, preparing for shipment

Shipped

Order dispatched to customer

Completed

Order delivered and confirmed

Cancelled

Order cancelled by customer or merchant

Refunded

Payment returned to customer

Viewing Order Details

  1. 1. Navigate to Orders in the dashboard
  2. 2. Browse orders or use search/filter options
  3. 3. Click on any order to view full details
  4. 4. View customer information, items, and order history

Order Synchronization

  • Orders sync automatically every 10 minutes from all connected stores
  • Webhook support for real-time order notifications (where supported by platform)
  • Manual sync available with "Refresh Orders" button

Install as Mobile App (PWA)

ShopSync is a Progressive Web App (PWA), which means you can install it on your device for a native app experience with offline capabilities.

iOS (Safari)

  1. 1.Open ShopSync in Safari browser
  2. 2.Tap the Share button (square with arrow)
  3. 3.Scroll down and tap "Add to Home Screen"
  4. 4.Tap "Add" to confirm
  5. 5.ShopSync icon will appear on your home screen

Android (Chrome)

  1. 1.Open ShopSync in Chrome browser
  2. 2.Tap the three-dot menu in the top right
  3. 3.Select "Install app" or "Add to Home Screen"
  4. 4.Tap "Install" to confirm
  5. 5.App will be added to your app drawer

Offline Mode

Once installed as a PWA, ShopSync works offline with these capabilities:

  • View previously loaded products and orders
  • Scan barcodes and save products to queue
  • Make changes that sync when connection restored
  • Access all cached data without internet

Troubleshooting & FAQ

Camera not working for barcode scanning

Possible causes and solutions:

  • • Check browser permissions - ensure camera access is allowed
  • • Try a different browser (Chrome and Safari work best)
  • • Make sure no other app is using the camera
  • • On iOS, use Safari (Chrome on iOS doesn't support camera API)
  • • Clear browser cache and reload the page

Products not syncing to my store

Check these points:

  • • Verify your shop connection is active (check Shops page)
  • • Check that API credentials have not expired
  • • Ensure "Read/Write" permissions are set in WooCommerce
  • • Look for sync errors in the sync log
  • • Try manually triggering a sync with "Sync Now"

Can't log in with social account

Try these steps:

  • • Make sure pop-ups are not blocked in your browser
  • • Clear cookies and try again
  • • Try logging in directly with the provider first
  • • Check if you have an account with that email already
  • • Use a different browser or incognito mode

Barcode not being recognized

Tips for better scanning:

  • • Ensure good lighting on the barcode
  • • Hold camera steady and at right distance (10-20cm)
  • • Make sure barcode is not damaged or wrinkled
  • • Try different angles if first attempt fails
  • • Clean camera lens if blurry
  • • Some barcodes may not be in our database - add manually

How do I manage multiple stores?

Answer:

You can connect unlimited stores in the Shops section. Each product can be linked to one or more shops, and changes sync independently to each connected platform.

Use the shop filter in Products and Orders pages to view data from specific stores.

Is my data secure?

Answer:

Yes! We use enterprise-grade security with encrypted credentials, Row Level Security (RLS) on all database tables, and HTTPS-only connections. Your API keys are encrypted at rest and never exposed in logs or to other users.

Technical Reference

Database Schema Overview

ShopSync uses Supabase (PostgreSQL) with the following main tables:

user_profiles: Extended user information beyond authentication
shops: Connected e-commerce stores
platform_credentials: Encrypted API credentials for each shop
products: Unified product catalog across platforms
ean_products: Cached barcode lookup data
orders: Orders from all connected platforms
sync_logs: History of synchronization operations
offline_queue: Operations performed while offline

Supported Barcode Formats

  • EAN-13: Standard European Article Number (13 digits)
  • EAN-8: Shortened version for small packages (8 digits)
  • UPC-A: Universal Product Code (North America, 12 digits)

Browser Compatibility

Fully Supported

  • • Chrome 90+ (Desktop & Android)
  • • Safari 14+ (Desktop & iOS)
  • • Edge 90+
  • • Firefox 88+

Limited Support

  • • Older browsers (no camera API)
  • • Chrome on iOS (use Safari instead)
  • • Internet Explorer (not supported)

Need More Help?

If you couldn't find the answer to your question in this documentation, we're here to help!

Email Support

Get help from our support team

support@shopsync.com

Community Forum

Connect with other users

Coming Soon

Check Out Our Roadmap

See what features we're working on and what's coming next.

View Roadmap