Overview

This SOP outlines the process for onboarding a Shopify customer using:

  • Windward Staging Core
  • Windward Data Gateway
  • Shopify Lite integration

Prerequisites

✅ Cloud Ops has completed:

  • Database setup
  • Staging initialization

✅ System requirements:

  • DSN configured
  • Record tracking enabled
  • Required tables decrypted

Phase 1: Environment Setup (Customer Care)

Step 1: Install Windward Data Gateway

  • Download installer (PowerShell script)
  • Run on server
  • Input:
    • Data set path
    • Serial number
    • Customer info

Step 2: Deploy Staging Core

  • Open Deployment App
  • Select customer dataset
  • Configure:
    • DLL path (must NOT match gateway folder)
    • Service bus queue (unique per tenant)

✅ Expected result:

  • All deployment steps return Green (Success)

Step 3: Validate Connection

  • Run Windward Connect test
  • Confirm logs show successful execution

Step 4: Enable Staging

  • Enable staging flag
  • Configure tenant ID and URLs

Phase 2: Shopify Setup (PS Team)

Step 5: Create Shopify Custom App

In Shopify Dev Dashboard:

  1. Create new app
  2. Configure:
    • API Version: latest supported
    • Required scopes (inventory, orders, etc.)
  3. Set Custom Distribution (Required)
  4. Release app

Step 6: Install App to Store

  • Install app in Shopify admin
  • Confirm permissions accepted

Step 7: Collect Credentials

Retrieve:

  • Client ID
  • Client Secret
  • Site URL

Phase 3: Integration Deployment

Step 8: Configure Shopify in Deployment App

  • Enter:
    • Client ID
    • Secret
    • Site URL
  • Save configuration

Step 9: Deploy Functions

Functions created:

  • Sync orders
  • Sync inventory
  • Sync stock
  • Sync images

⚠️ Default:

  • Images OFF
  • Others as needed

Phase 4: Configuration

Step 10: Category Mapping

  • Open Category Map
  • Map System 5 categories → Shopify taxonomies
  • Save changes

Step 11: Tax Mapping

  • Map:
    • Shopify tax names → System 5 tax numbers

✅ Canadian:

  • Predefined mapping

⚠️ US:

  • May require manual or global mapping

Phase 5: Activation

Step 12: Enable Functions

Based on go-live readiness:

  • Enable:
    • Inventory sync
    • Stock sync
    • Order sync

Validation Checklist

✅ Gateway running
✅ Staging core deployed (green status)
✅ Shopify app installed
✅ Credentials working
✅ Items visible in Shopify
✅ Sync functions operational


Important Notes / Best Practices

  • Do NOT enable image sync unless required
  • Ensure SKU = System 5 Part Number alignment
  • Decrypt tables before deployment
  • Avoid enabling unused functions (prevents alerts)
  • Do not delete items from Shopify before removing from export

Troubleshooting

IssueCauseAction
Orders not syncingInvalid credentialsRe-enter Client ID/Secret
Missing inventory dataEncrypted tablesDecrypt tables
Duplicate productsSKU mismatchAlign SKU with part number
Tax errorsMissing mappingUpdate tax mapping
API errors (429)Rate limitingAllow queued sync to complete

Escalation

Contact Development if:

  • Deployment shows errors (red)
  • Shopify API issues persist
  • Custom distribution setup fails